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.
446 menu "Memory commands"
451 Compute binary operations (xor, or, and) of byte arrays of arbitrary
452 size from memory and store the result in memory or the environment.
465 Add -v option to verify data against a crc32 checksum.
468 bool "eeprom - EEPROM subsystem"
470 (deprecated, needs conversion to driver model)
471 Provides commands to read and write EEPROM (Electrically Erasable
472 Programmable Read Only Memory) chips that are connected over an
475 config CMD_EEPROM_LAYOUT
476 bool "Enable layout-aware eeprom commands"
477 depends on CMD_EEPROM
479 (deprecated, needs conversion to driver model)
480 When enabled, additional eeprom sub-commands become available.
482 eeprom print - prints the contents of the eeprom in a human-readable
483 way (eeprom layout fields, and data formatted to be fit for human
486 eeprom update - allows user to update eeprom fields by specifying
487 the field name, and providing the new data in a human readable format
488 (same format as displayed by the eeprom print command).
490 Both commands can either auto detect the layout, or be told which
494 __weak int parse_layout_version(char *str)
495 - override to provide your own layout name parsing
496 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
498 - override to setup the layout metadata based on the version
499 __weak int eeprom_layout_detect(unsigned char *data)
500 - override to provide your own algorithm for detecting layout
503 - contains various printing and updating functions for common
504 types of eeprom fields. Can be used for defining
507 config EEPROM_LAYOUT_HELP_STRING
508 string "Tells user what layout names are supported"
509 depends on CMD_EEPROM_LAYOUT
510 default "<not defined>"
512 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
518 Infinite write loop on address range
525 Compute MD5 checksum.
530 depends on CMD_MD5SUM
532 Add -v option to verify data against an MD5 checksum.
537 Display memory information.
540 bool "md, mm, nm, mw, cp, cmp, base, loop"
545 mm - memory modify (auto-incrementing address)
546 nm - memory modify (constant address)
547 mw - memory write (fill)
550 base - print or set address offset
551 loop - initialize loop on address range
556 Simple RAM read/write test.
560 config SYS_ALT_MEMTEST
561 bool "Alternative test"
563 Use a more complete alternative memory test.
570 mdc - memory display cyclic
571 mwc - memory write cyclic
577 Compute SHA1 checksum.
579 config SHA1SUM_VERIFY
581 depends on CMD_SHA1SUM
583 Add -v option to verify data against a SHA1 checksum.
586 bool "strings - display strings in memory"
588 This works similarly to the Unix 'strings' command except that it
589 works with a memory range. String of printable characters found
590 within the range are displayed. The minimum number of characters
591 for a sequence to be considered a string can be provided.
595 menu "Compression commands"
599 default y if CMD_BOOTI
602 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
607 default y if CMD_BOOTI
609 Uncompress a zip-compressed memory region.
614 Compress a memory region with zlib deflate method.
618 menu "Device access commands"
621 #depends on FLASH_CFI_DRIVER
624 ARM Ltd reference designs flash partition access
627 bool "adc - Access Analog to Digital Converters info and data"
631 Shows ADC device info and permit printing one-shot analog converted
632 data from a named Analog to Digital Converter.
637 depends on PARTITIONS
639 Read/modify/write the fields of Bootloader Control Block, usually
640 stored on the flash "misc" partition with its structure defined in:
641 https://android.googlesource.com/platform/bootable/recovery/+/master/
642 bootloader_message/include/bootloader_message/bootloader_message.h
644 Some real-life use-cases include (but are not limited to):
645 - Determine the "boot reason" (and act accordingly):
646 https://source.android.com/devices/bootloader/boot-reason
647 - Get/pass a list of commands from/to recovery:
648 https://android.googlesource.com/platform/bootable/recovery
649 - Inspect/dump the contents of the BCB fields
652 bool "bind/unbind - Bind or unbind a device to/from a driver"
655 Bind or unbind a device to/from a driver from the command line.
656 This is useful in situations where a device may be handled by several
657 drivers. For example, this can be used to bind a UDC to the usb ether
658 gadget driver from the command line.
661 bool "clk - Show clock frequencies"
664 Shows clock frequences by calling a sock_clk_dump() hook function.
665 This is depreated in favour of using the CLK uclass and accessing
666 clock values from associated drivers. However currently no command
670 bool "demo - Demonstration commands for driver model"
673 Provides a 'demo' command which can be used to play around with
674 driver model. To use this properly you will need to enable one or
675 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
676 Otherwise you will always get an empty list of devices. The demo
677 devices are defined in the sandbox device tree, so the easiest
678 option is to use sandbox and pass the -d point to sandbox's
685 Enables the command "dfu" which is used to have U-Boot create a DFU
686 class device via USB. This command requires that the "dfu_alt_info"
687 environment variable be set and define the alt settings to expose to
691 bool "dm - Access to driver model information"
694 Provides access to driver model data structures and information,
695 such as a list of devices, list of uclasses and the state of each
696 device (e.g. activated). This is not required for operation, but
697 can be useful to see the state of driver model for debugging or
701 bool "fastboot - Android fastboot support"
704 This enables the command "fastboot" which enables the Android
705 fastboot mode for the platform. Fastboot is a protocol for
706 downloading images, flashing and device control used on
707 Android devices. Fastboot requires either the network stack
708 enabled or support for acting as a USB device.
710 See doc/README.android-fastboot for more information.
713 bool "fdcboot - Boot from floppy device"
715 The 'fdtboot' command allows booting an image from a floppy disk.
718 bool "flinfo, erase, protect"
722 flinfo - print FLASH memory information
724 protect - enable or disable FLASH write protection
733 config CMD_FPGA_LOADBP
734 bool "fpga loadbp - load partial bitstream (Xilinx only)"
737 Supports loading an FPGA device from a bitstream buffer containing
740 config CMD_FPGA_LOADFS
741 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
744 Supports loading an FPGA device from a FAT filesystem.
746 config CMD_FPGA_LOADMK
747 bool "fpga loadmk - load bitstream from image"
750 Supports loading an FPGA device from a image generated by mkimage.
752 config CMD_FPGA_LOADP
753 bool "fpga loadp - load partial bitstream"
756 Supports loading an FPGA device from a bitstream buffer containing
759 config CMD_FPGA_LOAD_SECURE
760 bool "fpga loads - loads secure bitstreams (Xilinx only)"
763 Enables the fpga loads command which is used to load secure
764 (authenticated or encrypted or both) bitstreams on to FPGA.
767 bool "fpgad - dump FPGA registers"
769 (legacy, needs conversion to driver model)
770 Provides a way to dump FPGA registers by calling the board-specific
771 fpga_get_reg() function. This functions similarly to the 'md'
775 bool "fuse - support for the fuse subssystem"
777 (deprecated - needs conversion to driver model)
778 This allows reading, sensing, programming or overriding fuses
779 which control the behaviour of the device. The command uses the
788 bool "GPT (GUID Partition Table) command"
790 select HAVE_BLOCK_DEVICE
791 select PARTITION_UUIDS
794 Enable the 'gpt' command to ready and write GPT style partition
798 bool "GPT Random UUID generation"
801 Enable the generation of partitions with random UUIDs if none
804 config CMD_GPT_RENAME
805 bool "GPT partition renaming commands"
808 Enables the 'gpt' command to interchange names on two GPT
809 partitions via the 'gpt swap' command or to rename single
810 partitions via the 'rename' command.
813 bool "ide - Support for IDE drivers"
816 Provides an 'ide' command which allows accessing the IDE drive,
817 reseting the IDE interface, printing the partition table and
818 geting device info. It also enables the 'diskboot' command which
819 permits booting from an IDE drive.
822 bool "io - Support for performing I/O accesses"
824 Provides an 'iod' command to display I/O space and an 'iow' command
825 to write values to the I/O space. This can be useful for manually
826 checking the state of devices during boot when debugging device
830 bool "iotrace - Support for tracing I/O activity"
832 Provides an 'iotrace' command which supports recording I/O reads and
833 writes in a trace buffer in memory . It also maintains a checksum
834 of the trace records (even if space is exhausted) so that the
835 sequence of I/O accesses can be verified.
837 When debugging drivers it is useful to see what I/O accesses were
838 done and in what order.
840 Even if the individual accesses are of little interest it can be
841 useful to verify that the access pattern is consistent each time
842 an operation is performed. In this case a checksum can be used to
843 characterise the operation of a driver. The checksum can be compared
844 across different runs of the operation to verify that the driver is
847 In particular, when performing major refactoring of the driver, where
848 the access pattern should not change, the checksum provides assurance
849 that the refactoring work has not broken the driver.
851 This works by sneaking into the io.h heder for an architecture and
852 redirecting I/O accesses through iotrace's tracing mechanism.
854 For now no commands are provided to examine the trace buffer. The
855 format is fairly simple, so 'md' is a reasonable substitute.
857 Note: The checksum feature is only useful for I/O regions where the
858 contents do not change outside of software control. Where this is not
859 suitable you can fall back to manually comparing the addresses. It
860 might be useful to enhance tracing to only checksum the accesses and
861 not the data read/written.
871 bool "w1 - Support for Dallas 1-Wire protocol"
873 Dallas 1-wire protocol support
879 Load a binary file over serial line.
885 Load an S-Record file over serial line
890 MMC memory mapped support.
893 bool "Enable support for RPMB in the mmc command"
896 Enable the commands for reading, writing and programming the
897 key for the Replay Protection Memory Block partition in eMMC.
899 config CMD_MMC_SWRITE
901 depends on CMD_MMC && MMC_WRITE
904 Enable support for the "mmc swrite" command to write Android sparse
909 select MTD_PARTITIONS
911 MTD commands support.
915 default y if NAND_SUNXI
920 config CMD_NAND_TRIMFFS
921 bool "nand write.trimffs"
922 default y if ARCH_SUNXI
924 Allows one to skip empty pages when flashing something on a NAND.
926 config CMD_NAND_LOCK_UNLOCK
927 bool "nand lock/unlock"
929 NAND locking support.
931 config CMD_NAND_TORTURE
934 NAND torture support.
943 NVM Express device support
946 bool "mmc_spi - Set up MMC SPI device"
948 Provides a way to set up an MMC (Multimedia Card) SPI (Serial
949 Peripheral Interface) device. The device provides a means of
950 accessing an MMC device via SPI using a single data line, limited
951 to 20MHz. It is useful since it reduces the amount of protocol code
955 bool "onenand - access to onenand device"
957 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
958 various useful features. This command allows reading, writing,
959 and erasing blocks. It allso provides a way to show and change
960 bad blocks, and test the device.
965 Enable the 'osd' command which allows to query information from and
966 write text data to a on-screen display (OSD) device; a virtual device
967 associated with a display capable of displaying a text overlay on the
968 display it's associated with..
972 select HAVE_BLOCK_DEVICE
973 select PARTITION_UUIDS
975 Read and display information about the partition table on
979 bool "pci - Access PCI devices"
981 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
982 used on some devices to allow the CPU to communicate with its
983 peripherals. Sub-commands allow bus enumeration, displaying and
984 changing configuration space and a few other features.
987 bool "pinit - Set up PCMCIA device"
989 Provides a means to initialise a PCMCIA (Personal Computer Memory
990 Card International Association) device. This is an old standard from
991 about 1990. These devices are typically removable memory or network
992 cards using a standard 68-pin connector.
995 bool "pinmux - show pins muxing"
998 Parse all available pin-controllers and show pins muxing. This
999 is useful for debug purpoer to check the pin muxing and to know if
1000 a pin is configured as a GPIO or as an alternate function.
1005 Poweroff/Shutdown the system
1008 bool "read - Read binary data from a partition"
1010 Provides low-level access to the data in a partition.
1012 config CMD_REMOTEPROC
1014 depends on REMOTEPROC
1016 Support for Remote Processor control
1019 bool "sata - Access SATA subsystem"
1022 SATA (Serial Advanced Technology Attachment) is a serial bus
1023 standard for connecting to hard drives and other storage devices.
1024 This command provides information about attached devices and allows
1025 reading, writing and other operations.
1027 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1028 Attachment, where AT refers to an IBM AT (Advanced Technology)
1029 computer released in 1984.
1032 bool "saves - Save a file over serial in S-Record format"
1034 Provides a way to save a binary file using the Motorola S-Record
1035 format over the serial line.
1038 bool "scsi - Access to SCSI devices"
1041 This provides a 'scsi' command which provides access to SCSI (Small
1042 Computer System Interface) devices. The command provides a way to
1043 scan the bus, reset the bus, read and write data and get information
1047 bool "sdram - Print SDRAM configuration information"
1049 Provides information about attached SDRAM. This assumed that the
1050 SDRAM has an EEPROM with information that can be read using the
1051 I2C bus. This is only available on some boards.
1055 depends on DM_SPI_FLASH || SPI_FLASH
1060 bool "sf test - Allow testing of SPI flash"
1063 Provides a way to test that SPI flash is working correctly. The
1064 test is destructive, in that an area of SPI flash must be provided
1065 for the test to use. Performance information is also provided,
1066 measuring the performance of reading, writing and erasing in
1067 Mbps (Million Bits Per Second). This value should approximately
1068 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1069 everything is working properly.
1072 bool "sspi - Command to access spi device"
1075 SPI utility command.
1077 config DEFAULT_SPI_BUS
1078 int "default spi bus used by sspi command"
1082 config DEFAULT_SPI_MODE
1083 hex "default spi mode used by sspi command (see include/spi.h)"
1088 bool "tsi148 - Command to access tsi148 device"
1090 This provides various sub-commands to initialise and configure the
1091 Turndra tsi148 device. See the command help for full details.
1094 bool "universe - Command to set up the Turndra Universe controller"
1096 This allows setting up the VMEbus provided by this controller.
1097 See the command help for full details.
1101 select HAVE_BLOCK_DEVICE
1107 select USB_FUNCTION_SDP
1109 Enables the command "sdp" which is used to have U-Boot emulating the
1110 Serial Download Protocol (SDP) via USB.
1114 depends on USB_FUNCTION_ROCKUSB
1116 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1117 read/write info, image to/from devices. This enable rockusb command
1118 support to communication with rockusb device. for more detail about
1119 this command, please read doc/README.rockusb.
1121 config CMD_USB_MASS_STORAGE
1122 bool "UMS usb mass storage"
1123 select USB_FUNCTION_MASS_STORAGE
1125 USB mass storage support
1132 VirtIO block device support
1138 This provides commands to control the watchdog timer devices.
1144 Enable the command "axi" for accessing AXI (Advanced eXtensible
1145 Interface) busses, a on-chip interconnect specification for managing
1146 functional blocks in SoC designs, which is also often used in designs
1147 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1151 menu "Shell scripting commands"
1157 Echo args to console
1163 Return true/false on integer compare.
1169 Run script from memory
1175 Evaluate boolean and math expressions and store the result in an env
1177 Also supports loading the value at a memory location into a variable.
1178 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1185 bool "Network commands"
1195 bootp - boot image via network using BOOTP/TFTP protocol
1199 depends on CMD_BOOTP
1201 Boot image via network using DHCP/TFTP protocol
1203 config BOOTP_BOOTPATH
1204 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1206 depends on CMD_BOOTP
1208 Even though the config is called BOOTP_BOOTPATH, it stores the
1209 path in the variable 'rootpath'.
1212 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1214 depends on CMD_BOOTP
1216 The primary DNS server is stored as 'dnsip'. If two servers are
1217 returned, you must set BOOTP_DNS2 to store that second server IP
1221 bool "Store 'dnsip2' from BOOTP/DHCP server"
1222 depends on BOOTP_DNS
1224 If a DHCP client requests the DNS server IP from a DHCP server,
1225 it is possible that more than one DNS serverip is offered to the
1226 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1227 server IP will be stored in the additional environment
1228 variable "dnsip2". The first DNS serverip is always
1229 stored in the variable "dnsip", when BOOTP_DNS is defined.
1231 config BOOTP_GATEWAY
1232 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1234 depends on CMD_BOOTP
1236 config BOOTP_HOSTNAME
1237 bool "Request & store 'hostname' from BOOTP/DHCP server"
1239 depends on CMD_BOOTP
1241 The name may or may not be qualified with the local domain name.
1243 config BOOTP_PREFER_SERVERIP
1244 bool "serverip variable takes precedent over DHCP server IP."
1245 depends on CMD_BOOTP
1247 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1249 With this option enabled, the 'serverip' variable in the environment
1250 takes precedence over DHCP server IP and will only be set by the DHCP
1251 server if not already set in the environment.
1253 config BOOTP_SUBNETMASK
1254 bool "Request & store 'netmask' from BOOTP/DHCP server"
1256 depends on CMD_BOOTP
1258 config BOOTP_NTPSERVER
1259 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1260 depends on CMD_BOOTP
1263 bool "Send PXE client arch to BOOTP/DHCP server"
1265 depends on CMD_BOOTP && CMD_PXE
1267 Supported for ARM, ARM64, and x86 for now.
1269 config BOOTP_PXE_CLIENTARCH
1271 depends on BOOTP_PXE
1272 default 0x16 if ARM64
1276 config BOOTP_VCI_STRING
1278 depends on CMD_BOOTP
1279 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1280 default "U-Boot.armv8" if ARM64
1281 default "U-Boot.arm" if ARM
1288 tftpboot - boot image via network using TFTP protocol
1292 depends on CMD_TFTPBOOT
1294 TFTP put command, for uploading files to a server
1298 depends on CMD_TFTPBOOT
1300 Act as a TFTP server and boot the first received file
1302 config NET_TFTP_VARS
1303 bool "Control TFTP timeout and count through environment"
1304 depends on CMD_TFTPBOOT
1307 If set, allows controlling the TFTP timeout through the
1308 environment variable tftptimeout, and the TFTP maximum
1309 timeout count through the variable tftptimeoutcountmax.
1310 If unset, timeout and maximum are hard-defined as 1 second
1311 and 10 timouts per TFTP transfer.
1316 Boot image via network using RARP/TFTP protocol
1322 Boot image via network using NFS protocol.
1327 Enable MII utility commands.
1332 Send ICMP ECHO_REQUEST to network host
1337 Perform CDP network configuration
1342 Synchronize RTC via network
1347 Lookup the IP of a hostname
1349 config CMD_LINK_LOCAL
1353 Acquire a network IP address using the link-local protocol
1360 Allow control of L2 Ethernet switch commands. These are supported
1361 by the vsc9953 Ethernet driver at present. Sub-commands allow
1362 operations such as enabling / disabling a port and
1363 viewing/maintaining the filtering database (FDB)
1369 Boot image via network using PXE protocol
1374 Wait for wake-on-lan Magic Packet
1378 menu "Misc commands"
1381 bool "Enable 'bmp' command"
1382 depends on LCD || DM_VIDEO || VIDEO
1384 This provides a way to obtain information about a BMP-format iamge
1385 and to display it. BMP (which presumably stands for BitMaP) is a
1386 file format defined by Microsoft which supports images of various
1387 depths, formats and compression methods. Headers on the file
1388 determine the formats used. This command can be used by first loading
1389 the image into RAM, then using this command to look at it or display
1392 config CMD_BOOTCOUNT
1394 depends on BOOTCOUNT_LIMIT
1396 Enable the bootcount command, which allows interrogation and
1397 reset of the bootcounter.
1400 bool "Enable board-specific commands"
1402 (deprecated: instead, please define a Kconfig option for each command)
1404 Some boards have board-specific commands which are only enabled
1405 during developemnt and need to be turned off for production. This
1406 option provides a way to control this. The commands that are enabled
1407 vary depending on the board.
1409 config CMD_BKOPS_ENABLE
1410 bool "mmc bkops enable"
1414 Enable command for setting manual background operations handshake
1415 on a eMMC device. The feature is optionally available on eMMC devices
1416 conforming to standard >= 4.41.
1418 config CMD_BLOCK_CACHE
1419 bool "blkcache - control and stats for block cache"
1420 depends on BLOCK_CACHE
1421 default y if BLOCK_CACHE
1423 Enable the blkcache command, which can be used to control the
1424 operation of the cache functions.
1425 This is most useful when fine-tuning the operation of the cache
1426 during development, but also allows the cache to be disabled when
1427 it might hurt performance (e.g. when using the ums command).
1430 bool "icache or dcache"
1432 Enable the "icache" and "dcache" commands
1434 config CMD_CONITRACE
1435 bool "conitrace - trace console input codes"
1437 Enable the 'conitrace' command which displays the codes received
1438 from the console input as hexadecimal numbers.
1441 bool "Enable clear screen command 'cls'"
1442 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1445 Enable the 'cls' command which clears the screen contents
1446 on video frame buffer.
1449 bool "efidebug - display/configure UEFI environment"
1450 depends on EFI_LOADER
1451 select EFI_DEVICE_PATH_TO_TEXT
1454 Enable the 'efidebug' command which provides a subset of UEFI
1455 shell utility with simplified functionality. It will be useful
1456 particularly for managing boot parameters as well as examining
1457 various EFI status for debugging.
1459 config CMD_EXCEPTION
1460 bool "exception - raise exception"
1461 depends on ARM || RISCV || X86
1463 Enable the 'exception' command which allows to raise an exception.
1470 Enable the 'led' command which allows for control of LEDs supported
1471 by the board. The LEDs can be listed with 'led list' and controlled
1472 with led on/off/togle/blink. Any LED drivers can be controlled with
1473 this command, e.g. led_gpio.
1479 Enable the 'date' command for getting/setting the time/date in RTC
1485 Run commands and summarize execution time.
1488 bool "gettime - read elapsed time"
1490 Enable the 'gettime' command which reads the elapsed time since
1491 U-Boot started running. This shows the time in seconds and
1492 milliseconds. See also the 'bootstage' command which provides more
1493 flexibility for boot timing.
1495 # TODO: rename to CMD_SLEEP
1500 Delay execution for some time
1503 bool "support for multiprocessor"
1505 This provides an option to brinup
1506 different processors in multiprocessor
1512 Access the system timer.
1518 This provides basic access to the U-Boot's sound support. The main
1519 feature is to play a beep.
1521 sound init - set up sound system
1522 sound play - play a sound
1528 This provides access to the QEMU firmware interface. The main
1529 feature is to allow easy loading of files passed to qemu-system
1530 via -kernel / -initrd
1532 source "cmd/mvebu/Kconfig"
1535 bool "terminal - provides a way to attach a serial terminal"
1537 Provides a 'cu'-like serial terminal command. This can be used to
1538 access other serial ports from the system console. The terminal
1539 is very simple with no special processing of characters. As with
1540 cu, you can press ~. (tilde followed by period) to exit.
1543 bool "uuid, guid - generation of unique IDs"
1546 This enables two commands:
1548 uuid - generate random Universally Unique Identifier
1549 guid - generate Globally Unique Identifier based on random UUID
1551 The two commands are very similar except for the endianness of the
1556 source "cmd/ti/Kconfig"
1558 config CMD_BOOTSTAGE
1559 bool "Enable the 'bootstage' command"
1560 depends on BOOTSTAGE
1562 Add a 'bootstage' command which supports printing a report
1563 and un/stashing of bootstage data.
1565 menu "Power commands"
1567 bool "Enable Driver Model PMIC command"
1570 This is the pmic command, based on a driver model pmic's API.
1571 Command features are unchanged:
1572 - list - list pmic devices
1573 - pmic dev <id> - show or [set] operating pmic device (NEW)
1574 - pmic dump - dump registers
1575 - pmic read address - read byte of register at address
1576 - pmic write address - write byte to register at address
1577 The only one change for this command is 'dev' subcommand.
1579 config CMD_REGULATOR
1580 bool "Enable Driver Model REGULATOR command"
1581 depends on DM_REGULATOR
1583 This command is based on driver model regulator's API.
1584 User interface features:
1585 - list - list regulator devices
1586 - regulator dev <id> - show or [set] operating regulator device
1587 - regulator info - print constraints info
1588 - regulator status - print operating status
1589 - regulator value <val] <-f> - print/[set] voltage value [uV]
1590 - regulator current <val> - print/[set] current value [uA]
1591 - regulator mode <id> - print/[set] operating mode id
1592 - regulator enable - enable the regulator output
1593 - regulator disable - disable the regulator output
1595 The '-f' (force) option can be used for set the value which exceeds
1596 the limits, which are found in device-tree and are kept in regulator's
1597 uclass platdata structure.
1601 menu "Security commands"
1603 bool "Enable the 'aes' command"
1606 This provides a means to encrypt and decrypt data using the AES
1607 (Advanced Encryption Standard). This algorithm uses a symetric key
1608 and is widely used as a streaming cipher. Different key lengths are
1609 supported by the algorithm but this command only supports 128 bits
1613 bool "Enable the 'blob' command"
1615 This is used with the Freescale secure boot mechanism.
1617 Freescale's SEC block has built-in Blob Protocol which provides
1618 a method for protecting user-defined data across system power
1619 cycles. SEC block protects data in a data structure called a Blob,
1620 which provides both confidentiality and integrity protection.
1622 Encapsulating data as a blob
1623 Each time that the Blob Protocol is used to protect data, a
1624 different randomly generated key is used to encrypt the data.
1625 This random key is itself encrypted using a key which is derived
1626 from SoC's non-volatile secret key and a 16 bit Key identifier.
1627 The resulting encrypted key along with encrypted data is called a
1628 blob. The non-volatile secure key is available for use only during
1631 During decapsulation, the reverse process is performed to get back
1635 blob enc - encapsulating data as a cryptgraphic blob
1636 blob dec - decapsulating cryptgraphic blob to get the data
1640 blob enc src dst len km
1642 Encapsulate and create blob of data $len bytes long
1643 at address $src and store the result at address $dst.
1644 $km is the 16 byte key modifier is also required for
1645 generation/use as key for cryptographic operation. Key
1646 modifier should be 16 byte long.
1648 blob dec src dst len km
1650 Decapsulate the blob of data at address $src and
1651 store result of $len byte at addr $dst.
1652 $km is the 16 byte key modifier is also required for
1653 generation/use as key for cryptographic operation. Key
1654 modifier should be 16 byte long.
1657 bool "Support 'hash' command"
1660 This provides a way to hash data in memory using various supported
1661 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1662 saved to memory or to an environment variable. It is also possible
1663 to verify a hash against data in memory.
1666 bool "Support the 'hvc' command"
1667 depends on ARM_SMCCC
1669 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1670 development and testing.
1673 bool "Support the 'smc' command"
1674 depends on ARM_SMCCC
1676 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1677 development and testing.
1683 Add -v option to verify data against a hash.
1693 bool "Enable the 'tpm' command"
1694 depends on TPM_V1 || TPM_V2
1695 select CMD_TPM_V1 if TPM_V1
1696 select CMD_TPM_V2 if TPM_V2
1698 This provides a means to talk to a TPM from the command line. A wide
1699 range of commands if provided - see 'tpm help' for details. The
1700 command requires a suitable TPM on your board and the correct driver
1706 bool "Enable the 'tpm test' command"
1709 This provides a a series of tests to confirm that the TPMv1.x is
1710 working correctly. The tests cover initialisation, non-volatile RAM,
1711 extend, global lock and checking that timing is within expectations.
1712 The tests pass correctly on Infineon TPMs but may need to be adjusted
1719 menu "Firmware commands"
1721 bool "Enable crosec command"
1725 Enable command-line access to the Chrome OS EC (Embedded
1726 Controller). This provides the 'crosec' command which has
1727 a number of sub-commands for performing EC tasks such as
1728 updating its flash, accessing a small saved context area
1729 and talking to the I2C bus behind the EC (if there is one).
1732 menu "Filesystem commands"
1734 bool "Enable the 'btrsubvol' command"
1737 This enables the 'btrsubvol' command to list subvolumes
1738 of a BTRFS filesystem. There are no special commands for
1739 listing BTRFS directories or loading BTRFS files - this
1740 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1741 when BTRFS is enabled (see FS_BTRFS).
1744 bool "Enable the 'cbfs' command"
1747 Define this to enable support for reading from a Coreboot
1748 filesystem. This is a ROM-based filesystem used for accessing files
1749 on systems that use coreboot as the first boot-loader and then load
1750 U-Boot to actually boot the Operating System. Available commands are
1751 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1754 bool "Enable the 'cramfs' command"
1755 depends on FS_CRAMFS
1757 This provides commands for dealing with CRAMFS (Compressed ROM
1758 filesystem). CRAMFS is useful when space is tight since files are
1759 compressed. Two commands are provided:
1761 cramfsls - lists files in a cramfs image
1762 cramfsload - loads a file from a cramfs image
1765 bool "ext2 command support"
1768 Enables EXT2 FS command
1771 bool "ext4 command support"
1774 Enables EXT4 FS command
1776 config CMD_EXT4_WRITE
1778 bool "ext4 write command support"
1781 Enables EXT4 FS write command
1784 bool "FAT command support"
1787 Support for the FAT fs
1789 config CMD_FS_GENERIC
1790 bool "filesystem commands"
1792 Enables filesystem commands (e.g. load, ls) that work for multiple
1796 bool "fsuuid command"
1798 Enables fsuuid command for filesystem UUID.
1801 bool "jffs2 command"
1804 Enables commands to support the JFFS2 (Journalling Flash File System
1805 version 2) filesystem. This enables fsload, ls and fsinfo which
1806 provide the ability to load files, list directories and obtain
1807 filesystem information.
1810 bool "MTD partition support"
1811 select MTD_DEVICE if (CMD_NAND || NAND)
1813 MTD partitioning tool support.
1814 It is strongly encouraged to avoid using this command
1815 anymore along with 'sf', 'nand', 'onenand'. One can still
1816 declare the partitions in the mtdparts environment variable
1817 but better use the MTD stack and the 'mtd' command instead.
1819 config MTDIDS_DEFAULT
1820 string "Default MTD IDs"
1821 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1823 Defines a default MTD IDs list for use with MTD partitions in the
1824 Linux MTD command line partitions format.
1826 config MTDPARTS_DEFAULT
1827 string "Default MTD partition scheme"
1828 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1830 Defines a default MTD partitioning scheme in the Linux MTD command
1831 line partitions format
1833 config CMD_MTDPARTS_SPREAD
1834 bool "Padd partition size to take account of bad blocks"
1835 depends on CMD_MTDPARTS
1837 This enables the 'spread' sub-command of the mtdparts command.
1838 This command will modify the existing mtdparts variable by increasing
1839 the size of the partitions such that 1) each partition's net size is
1840 at least as large as the size specified in the mtdparts variable and
1841 2) each partition starts on a good block.
1844 bool "reiser - Access to reiserfs filesystems"
1846 This provides two commands which operate on a resierfs filesystem,
1847 commonly used some years ago:
1849 reiserls - list files
1850 reiserload - load a file
1853 bool "yaffs2 - Access of YAFFS2 filesystem"
1857 This provides commands for accessing a YAFFS2 filesystem. Yet
1858 Another Flash Filesystem 2 is a filesystem designed specifically
1859 for NAND flash. It incorporates bad-block management and ensures
1860 that device writes are sequential regardless of filesystem
1864 bool "zfs - Access of ZFS filesystem"
1866 This provides commands to accessing a ZFS filesystem, commonly used
1867 on Solaris systems. Two sub-commands are provided:
1869 zfsls - list files in a directory
1870 zfsload - load a file
1872 See doc/README.zfs for more details.
1876 menu "Debug commands"
1881 The bedbug (emBEDded deBUGger) command provides debugging features
1882 for some PowerPC processors. For details please see the
1883 docuemntation in doc/README.beddbug
1886 bool "diag - Board diagnostics"
1888 This command provides access to board diagnostic tests. These are
1889 called Power-on Self Tests (POST). The command allows listing of
1890 available tests and running either all the tests, or specific tests
1894 bool "irq - Show information about interrupts"
1895 depends on !ARM && !MIPS && !SH
1897 This enables two commands:
1899 interrupts - enable or disable interrupts
1900 irqinfo - print device-specific interrupt information
1903 bool "kgdb - Allow debugging of U-Boot with gdb"
1906 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1907 over a serial link for debugging purposes. This allows
1908 single-stepping, inspecting variables, etc. This is supported only
1909 on PowerPC at present.
1912 bool "log - Generation, control and access to logging"
1915 This provides access to logging features. It allows the output of
1916 log data to be controlled to a limited extent (setting up the default
1917 maximum log level for emitting of records). It also provides access
1918 to a command used for testing the log system.
1921 bool "trace - Support tracing of function calls and timing"
1923 Enables a command to control using of function tracing within
1924 U-Boot. This allows recording of call traces including timing
1925 information. The command can write data to memory for exporting
1926 for analysis (e.g. using bootchart). See doc/README.trace for full
1930 bool "avb - Android Verified Boot 2.0 operations"
1931 depends on AVB_VERIFY
1934 Enables a "avb" command to perform verification of partitions using
1935 Android Verified Boot 2.0 functionality. It includes such subcommands:
1936 avb init - initialize avb2 subsystem
1937 avb read_rb - read rollback index
1938 avb write_rb - write rollback index
1939 avb is_unlocked - check device lock state
1940 avb get_uuid - read and print uuid of a partition
1941 avb read_part - read data from partition
1942 avb read_part_hex - read data from partition and output to stdout
1943 avb write_part - write data to partition
1944 avb verify - run full verification chain
1948 tristate "Enable UBI - Unsorted block images commands"
1951 UBI is a software layer above MTD layer which admits use of LVM-like
1952 logical volumes on top of MTD devices, hides some complexities of
1953 flash chips like wear and bad blocks and provides some other useful
1954 capabilities. Please, consult the MTD web site for more details
1955 (www.linux-mtd.infradead.org). Activate this option if you want
1956 to use U-Boot UBI commands.
1957 It is also strongly encouraged to also enable CONFIG_MTD to get full
1961 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1963 default y if CMD_UBI
1966 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob