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
414 depends on CMD_SAVEENV
416 Erase environment variables from the compiled-in persistent
419 config CMD_ENV_EXISTS
423 Check if a variable is defined in the environment for use in
426 config CMD_ENV_CALLBACK
427 bool "env callbacks - print callbacks and their associated variables"
429 Some environment variable have callbacks defined by
430 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
431 For example changing "baudrate" adjust the serial baud rate. This
432 command lists the currently defined callbacks.
435 bool "env flags -print variables that have non-default flags"
437 Some environment variables have special flags that control their
438 behaviour. For example, serial# can only be written once and cannot
439 be deleted. This command shows the variables that have special
442 config CMD_NVEDIT_EFI
443 bool "env [set|print] -e - set/print UEFI variables"
444 depends on EFI_LOADER
448 UEFI variables are encoded as some form of U-Boot variables.
449 If enabled, we are allowed to set/print UEFI variables using
450 "env" command with "-e" option without knowing details.
452 config CMD_NVEDIT_INFO
453 bool "env info - print or evaluate environment information"
455 Print environment information:
456 - env_valid : is environment valid
457 - env_ready : is environment imported into hash table
458 - env_use_default : is default environment used
460 This command can be optionally used for evaluation in scripts:
461 [-d] : evaluate whether default environment is used
462 [-p] : evaluate whether environment can be persisted
463 The result of multiple evaluations will be combined with AND.
467 menu "Memory commands"
472 Compute binary operations (xor, or, and) of byte arrays of arbitrary
473 size from memory and store the result in memory or the environment.
486 Add -v option to verify data against a crc32 checksum.
489 bool "eeprom - EEPROM subsystem"
491 (deprecated, needs conversion to driver model)
492 Provides commands to read and write EEPROM (Electrically Erasable
493 Programmable Read Only Memory) chips that are connected over an
496 config CMD_EEPROM_LAYOUT
497 bool "Enable layout-aware eeprom commands"
498 depends on CMD_EEPROM
500 (deprecated, needs conversion to driver model)
501 When enabled, additional eeprom sub-commands become available.
503 eeprom print - prints the contents of the eeprom in a human-readable
504 way (eeprom layout fields, and data formatted to be fit for human
507 eeprom update - allows user to update eeprom fields by specifying
508 the field name, and providing the new data in a human readable format
509 (same format as displayed by the eeprom print command).
511 Both commands can either auto detect the layout, or be told which
515 __weak int parse_layout_version(char *str)
516 - override to provide your own layout name parsing
517 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
519 - override to setup the layout metadata based on the version
520 __weak int eeprom_layout_detect(unsigned char *data)
521 - override to provide your own algorithm for detecting layout
524 - contains various printing and updating functions for common
525 types of eeprom fields. Can be used for defining
528 config EEPROM_LAYOUT_HELP_STRING
529 string "Tells user what layout names are supported"
530 depends on CMD_EEPROM_LAYOUT
531 default "<not defined>"
533 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
539 Infinite write loop on address range
546 Compute MD5 checksum.
551 depends on CMD_MD5SUM
553 Add -v option to verify data against an MD5 checksum.
558 Display memory information.
561 bool "md, mm, nm, mw, cp, cmp, base, loop"
566 mm - memory modify (auto-incrementing address)
567 nm - memory modify (constant address)
568 mw - memory write (fill)
571 base - print or set address offset
572 loop - initialize loop on address range
577 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
579 random - fill memory with random data
584 Simple RAM read/write test.
588 config SYS_ALT_MEMTEST
589 bool "Alternative test"
591 Use a more complete alternative memory test.
598 mdc - memory display cyclic
599 mwc - memory write cyclic
605 Compute SHA1 checksum.
607 config SHA1SUM_VERIFY
609 depends on CMD_SHA1SUM
611 Add -v option to verify data against a SHA1 checksum.
614 bool "strings - display strings in memory"
616 This works similarly to the Unix 'strings' command except that it
617 works with a memory range. String of printable characters found
618 within the range are displayed. The minimum number of characters
619 for a sequence to be considered a string can be provided.
623 menu "Compression commands"
627 default y if CMD_BOOTI
630 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
635 default y if CMD_BOOTI
637 Uncompress a zip-compressed memory region.
642 Compress a memory region with zlib deflate method.
646 menu "Device access commands"
649 #depends on FLASH_CFI_DRIVER
652 ARM Ltd reference designs flash partition access
655 bool "adc - Access Analog to Digital Converters info and data"
659 Shows ADC device info and permit printing one-shot analog converted
660 data from a named Analog to Digital Converter.
665 depends on PARTITIONS
667 Read/modify/write the fields of Bootloader Control Block, usually
668 stored on the flash "misc" partition with its structure defined in:
669 https://android.googlesource.com/platform/bootable/recovery/+/master/
670 bootloader_message/include/bootloader_message/bootloader_message.h
672 Some real-life use-cases include (but are not limited to):
673 - Determine the "boot reason" (and act accordingly):
674 https://source.android.com/devices/bootloader/boot-reason
675 - Get/pass a list of commands from/to recovery:
676 https://android.googlesource.com/platform/bootable/recovery
677 - Inspect/dump the contents of the BCB fields
680 bool "bind/unbind - Bind or unbind a device to/from a driver"
683 Bind or unbind a device to/from a driver from the command line.
684 This is useful in situations where a device may be handled by several
685 drivers. For example, this can be used to bind a UDC to the usb ether
686 gadget driver from the command line.
689 bool "clk - Show clock frequencies"
692 Shows clock frequences by calling a sock_clk_dump() hook function.
693 This is depreated in favour of using the CLK uclass and accessing
694 clock values from associated drivers. However currently no command
698 bool "demo - Demonstration commands for driver model"
701 Provides a 'demo' command which can be used to play around with
702 driver model. To use this properly you will need to enable one or
703 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
704 Otherwise you will always get an empty list of devices. The demo
705 devices are defined in the sandbox device tree, so the easiest
706 option is to use sandbox and pass the -d point to sandbox's
713 Enables the command "dfu" which is used to have U-Boot create a DFU
714 class device via USB. This command requires that the "dfu_alt_info"
715 environment variable be set and define the alt settings to expose to
719 bool "dm - Access to driver model information"
722 Provides access to driver model data structures and information,
723 such as a list of devices, list of uclasses and the state of each
724 device (e.g. activated). This is not required for operation, but
725 can be useful to see the state of driver model for debugging or
729 bool "fastboot - Android fastboot support"
732 This enables the command "fastboot" which enables the Android
733 fastboot mode for the platform. Fastboot is a protocol for
734 downloading images, flashing and device control used on
735 Android devices. Fastboot requires either the network stack
736 enabled or support for acting as a USB device.
738 See doc/README.android-fastboot for more information.
741 bool "fdcboot - Boot from floppy device"
743 The 'fdtboot' command allows booting an image from a floppy disk.
746 bool "flinfo, erase, protect"
750 flinfo - print FLASH memory information
752 protect - enable or disable FLASH write protection
761 config CMD_FPGA_LOADBP
762 bool "fpga loadbp - load partial bitstream (Xilinx only)"
765 Supports loading an FPGA device from a bitstream buffer containing
768 config CMD_FPGA_LOADFS
769 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
772 Supports loading an FPGA device from a FAT filesystem.
774 config CMD_FPGA_LOADMK
775 bool "fpga loadmk - load bitstream from image"
778 Supports loading an FPGA device from a image generated by mkimage.
780 config CMD_FPGA_LOADP
781 bool "fpga loadp - load partial bitstream"
784 Supports loading an FPGA device from a bitstream buffer containing
787 config CMD_FPGA_LOAD_SECURE
788 bool "fpga loads - loads secure bitstreams (Xilinx only)"
791 Enables the fpga loads command which is used to load secure
792 (authenticated or encrypted or both) bitstreams on to FPGA.
795 bool "fpgad - dump FPGA registers"
797 (legacy, needs conversion to driver model)
798 Provides a way to dump FPGA registers by calling the board-specific
799 fpga_get_reg() function. This functions similarly to the 'md'
803 bool "fuse - support for the fuse subssystem"
805 (deprecated - needs conversion to driver model)
806 This allows reading, sensing, programming or overriding fuses
807 which control the behaviour of the device. The command uses the
816 bool "GPT (GUID Partition Table) command"
818 select HAVE_BLOCK_DEVICE
819 select PARTITION_UUIDS
822 Enable the 'gpt' command to ready and write GPT style partition
826 bool "GPT Random UUID generation"
829 Enable the generation of partitions with random UUIDs if none
832 config CMD_GPT_RENAME
833 bool "GPT partition renaming commands"
836 Enables the 'gpt' command to interchange names on two GPT
837 partitions via the 'gpt swap' command or to rename single
838 partitions via the 'rename' command.
841 bool "ide - Support for IDE drivers"
844 Provides an 'ide' command which allows accessing the IDE drive,
845 reseting the IDE interface, printing the partition table and
846 geting device info. It also enables the 'diskboot' command which
847 permits booting from an IDE drive.
850 bool "io - Support for performing I/O accesses"
852 Provides an 'iod' command to display I/O space and an 'iow' command
853 to write values to the I/O space. This can be useful for manually
854 checking the state of devices during boot when debugging device
858 bool "iotrace - Support for tracing I/O activity"
860 Provides an 'iotrace' command which supports recording I/O reads and
861 writes in a trace buffer in memory . It also maintains a checksum
862 of the trace records (even if space is exhausted) so that the
863 sequence of I/O accesses can be verified.
865 When debugging drivers it is useful to see what I/O accesses were
866 done and in what order.
868 Even if the individual accesses are of little interest it can be
869 useful to verify that the access pattern is consistent each time
870 an operation is performed. In this case a checksum can be used to
871 characterise the operation of a driver. The checksum can be compared
872 across different runs of the operation to verify that the driver is
875 In particular, when performing major refactoring of the driver, where
876 the access pattern should not change, the checksum provides assurance
877 that the refactoring work has not broken the driver.
879 This works by sneaking into the io.h heder for an architecture and
880 redirecting I/O accesses through iotrace's tracing mechanism.
882 For now no commands are provided to examine the trace buffer. The
883 format is fairly simple, so 'md' is a reasonable substitute.
885 Note: The checksum feature is only useful for I/O regions where the
886 contents do not change outside of software control. Where this is not
887 suitable you can fall back to manually comparing the addresses. It
888 might be useful to enhance tracing to only checksum the accesses and
889 not the data read/written.
899 bool "w1 - Support for Dallas 1-Wire protocol"
901 Dallas 1-wire protocol support
907 Load a binary file over serial line.
913 Load an S-Record file over serial line
918 MMC memory mapped support.
921 bool "Enable support for RPMB in the mmc command"
924 Enable the commands for reading, writing and programming the
925 key for the Replay Protection Memory Block partition in eMMC.
927 config CMD_MMC_SWRITE
929 depends on CMD_MMC && MMC_WRITE
932 Enable support for the "mmc swrite" command to write Android sparse
937 select MTD_PARTITIONS
939 MTD commands support.
943 default y if NAND_SUNXI
948 config CMD_NAND_TRIMFFS
949 bool "nand write.trimffs"
950 default y if ARCH_SUNXI
952 Allows one to skip empty pages when flashing something on a NAND.
954 config CMD_NAND_LOCK_UNLOCK
955 bool "nand lock/unlock"
957 NAND locking support.
959 config CMD_NAND_TORTURE
962 NAND torture support.
971 NVM Express device support
974 bool "onenand - access to onenand device"
976 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
977 various useful features. This command allows reading, writing,
978 and erasing blocks. It allso provides a way to show and change
979 bad blocks, and test the device.
984 Enable the 'osd' command which allows to query information from and
985 write text data to a on-screen display (OSD) device; a virtual device
986 associated with a display capable of displaying a text overlay on the
987 display it's associated with..
991 select HAVE_BLOCK_DEVICE
992 select PARTITION_UUIDS
994 Read and display information about the partition table on
998 bool "pci - Access PCI devices"
1000 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1001 used on some devices to allow the CPU to communicate with its
1002 peripherals. Sub-commands allow bus enumeration, displaying and
1003 changing configuration space and a few other features.
1006 bool "pinit - Set up PCMCIA device"
1008 Provides a means to initialise a PCMCIA (Personal Computer Memory
1009 Card International Association) device. This is an old standard from
1010 about 1990. These devices are typically removable memory or network
1011 cards using a standard 68-pin connector.
1014 bool "pinmux - show pins muxing"
1015 default y if PINCTRL
1017 Parse all available pin-controllers and show pins muxing. This
1018 is useful for debug purpoer to check the pin muxing and to know if
1019 a pin is configured as a GPIO or as an alternate function.
1024 Poweroff/Shutdown the system
1027 bool "read - Read binary data from a partition"
1029 Provides low-level access to the data in a partition.
1031 config CMD_REMOTEPROC
1033 depends on REMOTEPROC
1035 Support for Remote Processor control
1038 bool "sata - Access SATA subsystem"
1041 SATA (Serial Advanced Technology Attachment) is a serial bus
1042 standard for connecting to hard drives and other storage devices.
1043 This command provides information about attached devices and allows
1044 reading, writing and other operations.
1046 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1047 Attachment, where AT refers to an IBM AT (Advanced Technology)
1048 computer released in 1984.
1051 bool "saves - Save a file over serial in S-Record format"
1053 Provides a way to save a binary file using the Motorola S-Record
1054 format over the serial line.
1057 bool "scsi - Access to SCSI devices"
1060 This provides a 'scsi' command which provides access to SCSI (Small
1061 Computer System Interface) devices. The command provides a way to
1062 scan the bus, reset the bus, read and write data and get information
1066 bool "sdram - Print SDRAM configuration information"
1068 Provides information about attached SDRAM. This assumed that the
1069 SDRAM has an EEPROM with information that can be read using the
1070 I2C bus. This is only available on some boards.
1074 depends on DM_SPI_FLASH || SPI_FLASH
1079 bool "sf test - Allow testing of SPI flash"
1082 Provides a way to test that SPI flash is working correctly. The
1083 test is destructive, in that an area of SPI flash must be provided
1084 for the test to use. Performance information is also provided,
1085 measuring the performance of reading, writing and erasing in
1086 Mbps (Million Bits Per Second). This value should approximately
1087 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1088 everything is working properly.
1091 bool "sspi - Command to access spi device"
1094 SPI utility command.
1096 config DEFAULT_SPI_BUS
1097 int "default spi bus used by sspi command"
1101 config DEFAULT_SPI_MODE
1102 hex "default spi mode used by sspi command (see include/spi.h)"
1107 bool "tsi148 - Command to access tsi148 device"
1109 This provides various sub-commands to initialise and configure the
1110 Turndra tsi148 device. See the command help for full details.
1113 bool "universe - Command to set up the Turndra Universe controller"
1115 This allows setting up the VMEbus provided by this controller.
1116 See the command help for full details.
1120 select HAVE_BLOCK_DEVICE
1126 select USB_FUNCTION_SDP
1128 Enables the command "sdp" which is used to have U-Boot emulating the
1129 Serial Download Protocol (SDP) via USB.
1133 depends on USB_FUNCTION_ROCKUSB
1135 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1136 read/write info, image to/from devices. This enable rockusb command
1137 support to communication with rockusb device. for more detail about
1138 this command, please read doc/README.rockusb.
1140 config CMD_USB_MASS_STORAGE
1141 bool "UMS usb mass storage"
1142 select USB_FUNCTION_MASS_STORAGE
1144 USB mass storage support
1151 VirtIO block device support
1157 This provides commands to control the watchdog timer devices.
1163 Enable the command "axi" for accessing AXI (Advanced eXtensible
1164 Interface) busses, a on-chip interconnect specification for managing
1165 functional blocks in SoC designs, which is also often used in designs
1166 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1170 menu "Shell scripting commands"
1176 Echo args to console
1182 Return true/false on integer compare.
1188 Run script from memory
1194 Evaluate boolean and math expressions and store the result in an env
1196 Also supports loading the value at a memory location into a variable.
1197 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1204 bool "Network commands"
1214 bootp - boot image via network using BOOTP/TFTP protocol
1218 depends on CMD_BOOTP
1220 Boot image via network using DHCP/TFTP protocol
1222 config BOOTP_BOOTPATH
1223 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1225 depends on CMD_BOOTP
1227 Even though the config is called BOOTP_BOOTPATH, it stores the
1228 path in the variable 'rootpath'.
1231 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1233 depends on CMD_BOOTP
1235 The primary DNS server is stored as 'dnsip'. If two servers are
1236 returned, you must set BOOTP_DNS2 to store that second server IP
1240 bool "Store 'dnsip2' from BOOTP/DHCP server"
1241 depends on BOOTP_DNS
1243 If a DHCP client requests the DNS server IP from a DHCP server,
1244 it is possible that more than one DNS serverip is offered to the
1245 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1246 server IP will be stored in the additional environment
1247 variable "dnsip2". The first DNS serverip is always
1248 stored in the variable "dnsip", when BOOTP_DNS is defined.
1250 config BOOTP_GATEWAY
1251 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1253 depends on CMD_BOOTP
1255 config BOOTP_HOSTNAME
1256 bool "Request & store 'hostname' from BOOTP/DHCP server"
1258 depends on CMD_BOOTP
1260 The name may or may not be qualified with the local domain name.
1262 config BOOTP_PREFER_SERVERIP
1263 bool "serverip variable takes precedent over DHCP server IP."
1264 depends on CMD_BOOTP
1266 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1268 With this option enabled, the 'serverip' variable in the environment
1269 takes precedence over DHCP server IP and will only be set by the DHCP
1270 server if not already set in the environment.
1272 config BOOTP_SUBNETMASK
1273 bool "Request & store 'netmask' from BOOTP/DHCP server"
1275 depends on CMD_BOOTP
1277 config BOOTP_NTPSERVER
1278 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1279 depends on CMD_BOOTP
1282 bool "Send PXE client arch to BOOTP/DHCP server"
1284 depends on CMD_BOOTP && CMD_PXE
1286 Supported for ARM, ARM64, and x86 for now.
1288 config BOOTP_PXE_CLIENTARCH
1290 depends on BOOTP_PXE
1291 default 0x16 if ARM64
1295 config BOOTP_VCI_STRING
1297 depends on CMD_BOOTP
1298 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1299 default "U-Boot.armv8" if ARM64
1300 default "U-Boot.arm" if ARM
1307 tftpboot - boot image via network using TFTP protocol
1311 depends on CMD_TFTPBOOT
1313 TFTP put command, for uploading files to a server
1317 depends on CMD_TFTPBOOT
1319 Act as a TFTP server and boot the first received file
1321 config NET_TFTP_VARS
1322 bool "Control TFTP timeout and count through environment"
1323 depends on CMD_TFTPBOOT
1326 If set, allows controlling the TFTP timeout through the
1327 environment variable tftptimeout, and the TFTP maximum
1328 timeout count through the variable tftptimeoutcountmax.
1329 If unset, timeout and maximum are hard-defined as 1 second
1330 and 10 timouts per TFTP transfer.
1335 Boot image via network using RARP/TFTP protocol
1341 Boot image via network using NFS protocol.
1346 Enable MII utility commands.
1351 Send ICMP ECHO_REQUEST to network host
1356 Perform CDP network configuration
1361 Synchronize RTC via network
1366 Lookup the IP of a hostname
1368 config CMD_LINK_LOCAL
1372 Acquire a network IP address using the link-local protocol
1379 Allow control of L2 Ethernet switch commands. These are supported
1380 by the vsc9953 Ethernet driver at present. Sub-commands allow
1381 operations such as enabling / disabling a port and
1382 viewing/maintaining the filtering database (FDB)
1388 Boot image via network using PXE protocol
1393 Wait for wake-on-lan Magic Packet
1397 menu "Misc commands"
1400 bool "Enable 'bmp' command"
1401 depends on LCD || DM_VIDEO || VIDEO
1403 This provides a way to obtain information about a BMP-format iamge
1404 and to display it. BMP (which presumably stands for BitMaP) is a
1405 file format defined by Microsoft which supports images of various
1406 depths, formats and compression methods. Headers on the file
1407 determine the formats used. This command can be used by first loading
1408 the image into RAM, then using this command to look at it or display
1411 config CMD_BOOTCOUNT
1413 depends on BOOTCOUNT_LIMIT
1415 Enable the bootcount command, which allows interrogation and
1416 reset of the bootcounter.
1419 bool "Enable board-specific commands"
1421 (deprecated: instead, please define a Kconfig option for each command)
1423 Some boards have board-specific commands which are only enabled
1424 during developemnt and need to be turned off for production. This
1425 option provides a way to control this. The commands that are enabled
1426 vary depending on the board.
1428 config CMD_BKOPS_ENABLE
1429 bool "mmc bkops enable"
1433 Enable command for setting manual background operations handshake
1434 on a eMMC device. The feature is optionally available on eMMC devices
1435 conforming to standard >= 4.41.
1437 config CMD_BLOCK_CACHE
1438 bool "blkcache - control and stats for block cache"
1439 depends on BLOCK_CACHE
1440 default y if BLOCK_CACHE
1442 Enable the blkcache command, which can be used to control the
1443 operation of the cache functions.
1444 This is most useful when fine-tuning the operation of the cache
1445 during development, but also allows the cache to be disabled when
1446 it might hurt performance (e.g. when using the ums command).
1449 bool "icache or dcache"
1451 Enable the "icache" and "dcache" commands
1453 config CMD_CONITRACE
1454 bool "conitrace - trace console input codes"
1456 Enable the 'conitrace' command which displays the codes received
1457 from the console input as hexadecimal numbers.
1460 bool "Enable clear screen command 'cls'"
1461 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1464 Enable the 'cls' command which clears the screen contents
1465 on video frame buffer.
1468 bool "efidebug - display/configure UEFI environment"
1469 depends on EFI_LOADER
1470 select EFI_DEVICE_PATH_TO_TEXT
1473 Enable the 'efidebug' command which provides a subset of UEFI
1474 shell utility with simplified functionality. It will be useful
1475 particularly for managing boot parameters as well as examining
1476 various EFI status for debugging.
1478 config CMD_EXCEPTION
1479 bool "exception - raise exception"
1480 depends on ARM || RISCV || X86
1482 Enable the 'exception' command which allows to raise an exception.
1489 Enable the 'led' command which allows for control of LEDs supported
1490 by the board. The LEDs can be listed with 'led list' and controlled
1491 with led on/off/togle/blink. Any LED drivers can be controlled with
1492 this command, e.g. led_gpio.
1498 Enable the 'date' command for getting/setting the time/date in RTC
1504 Run commands and summarize execution time.
1507 bool "gettime - read elapsed time"
1509 Enable the 'gettime' command which reads the elapsed time since
1510 U-Boot started running. This shows the time in seconds and
1511 milliseconds. See also the 'bootstage' command which provides more
1512 flexibility for boot timing.
1514 # TODO: rename to CMD_SLEEP
1519 Delay execution for some time
1522 bool "support for multiprocessor"
1524 This provides an option to brinup
1525 different processors in multiprocessor
1531 Access the system timer.
1537 This provides basic access to the U-Boot's sound support. The main
1538 feature is to play a beep.
1540 sound init - set up sound system
1541 sound play - play a sound
1547 This provides access to the QEMU firmware interface. The main
1548 feature is to allow easy loading of files passed to qemu-system
1549 via -kernel / -initrd
1551 source "cmd/mvebu/Kconfig"
1554 bool "terminal - provides a way to attach a serial terminal"
1556 Provides a 'cu'-like serial terminal command. This can be used to
1557 access other serial ports from the system console. The terminal
1558 is very simple with no special processing of characters. As with
1559 cu, you can press ~. (tilde followed by period) to exit.
1562 bool "uuid, guid - generation of unique IDs"
1565 This enables two commands:
1567 uuid - generate random Universally Unique Identifier
1568 guid - generate Globally Unique Identifier based on random UUID
1570 The two commands are very similar except for the endianness of the
1575 source "cmd/ti/Kconfig"
1577 config CMD_BOOTSTAGE
1578 bool "Enable the 'bootstage' command"
1579 depends on BOOTSTAGE
1581 Add a 'bootstage' command which supports printing a report
1582 and un/stashing of bootstage data.
1584 menu "Power commands"
1586 bool "Enable Driver Model PMIC command"
1589 This is the pmic command, based on a driver model pmic's API.
1590 Command features are unchanged:
1591 - list - list pmic devices
1592 - pmic dev <id> - show or [set] operating pmic device (NEW)
1593 - pmic dump - dump registers
1594 - pmic read address - read byte of register at address
1595 - pmic write address - write byte to register at address
1596 The only one change for this command is 'dev' subcommand.
1598 config CMD_REGULATOR
1599 bool "Enable Driver Model REGULATOR command"
1600 depends on DM_REGULATOR
1602 This command is based on driver model regulator's API.
1603 User interface features:
1604 - list - list regulator devices
1605 - regulator dev <id> - show or [set] operating regulator device
1606 - regulator info - print constraints info
1607 - regulator status - print operating status
1608 - regulator value <val] <-f> - print/[set] voltage value [uV]
1609 - regulator current <val> - print/[set] current value [uA]
1610 - regulator mode <id> - print/[set] operating mode id
1611 - regulator enable - enable the regulator output
1612 - regulator disable - disable the regulator output
1614 The '-f' (force) option can be used for set the value which exceeds
1615 the limits, which are found in device-tree and are kept in regulator's
1616 uclass platdata structure.
1620 menu "Security commands"
1622 bool "Enable the 'aes' command"
1625 This provides a means to encrypt and decrypt data using the AES
1626 (Advanced Encryption Standard). This algorithm uses a symetric key
1627 and is widely used as a streaming cipher. Different key lengths are
1628 supported by the algorithm but this command only supports 128 bits
1632 bool "Enable the 'blob' command"
1634 This is used with the Freescale secure boot mechanism.
1636 Freescale's SEC block has built-in Blob Protocol which provides
1637 a method for protecting user-defined data across system power
1638 cycles. SEC block protects data in a data structure called a Blob,
1639 which provides both confidentiality and integrity protection.
1641 Encapsulating data as a blob
1642 Each time that the Blob Protocol is used to protect data, a
1643 different randomly generated key is used to encrypt the data.
1644 This random key is itself encrypted using a key which is derived
1645 from SoC's non-volatile secret key and a 16 bit Key identifier.
1646 The resulting encrypted key along with encrypted data is called a
1647 blob. The non-volatile secure key is available for use only during
1650 During decapsulation, the reverse process is performed to get back
1654 blob enc - encapsulating data as a cryptgraphic blob
1655 blob dec - decapsulating cryptgraphic blob to get the data
1659 blob enc src dst len km
1661 Encapsulate and create blob of data $len bytes long
1662 at address $src and store the result at address $dst.
1663 $km is the 16 byte key modifier is also required for
1664 generation/use as key for cryptographic operation. Key
1665 modifier should be 16 byte long.
1667 blob dec src dst len km
1669 Decapsulate the blob of data at address $src and
1670 store result of $len byte at addr $dst.
1671 $km is the 16 byte key modifier is also required for
1672 generation/use as key for cryptographic operation. Key
1673 modifier should be 16 byte long.
1676 bool "Support 'hash' command"
1679 This provides a way to hash data in memory using various supported
1680 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1681 saved to memory or to an environment variable. It is also possible
1682 to verify a hash against data in memory.
1685 bool "Support the 'hvc' command"
1686 depends on ARM_SMCCC
1688 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1689 development and testing.
1692 bool "Support the 'smc' command"
1693 depends on ARM_SMCCC
1695 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1696 development and testing.
1702 Add -v option to verify data against a hash.
1712 bool "Enable the 'tpm' command"
1713 depends on TPM_V1 || TPM_V2
1714 select CMD_TPM_V1 if TPM_V1
1715 select CMD_TPM_V2 if TPM_V2
1717 This provides a means to talk to a TPM from the command line. A wide
1718 range of commands if provided - see 'tpm help' for details. The
1719 command requires a suitable TPM on your board and the correct driver
1725 bool "Enable the 'tpm test' command"
1728 This provides a a series of tests to confirm that the TPMv1.x is
1729 working correctly. The tests cover initialisation, non-volatile RAM,
1730 extend, global lock and checking that timing is within expectations.
1731 The tests pass correctly on Infineon TPMs but may need to be adjusted
1738 menu "Firmware commands"
1740 bool "Enable crosec command"
1744 Enable command-line access to the Chrome OS EC (Embedded
1745 Controller). This provides the 'crosec' command which has
1746 a number of sub-commands for performing EC tasks such as
1747 updating its flash, accessing a small saved context area
1748 and talking to the I2C bus behind the EC (if there is one).
1751 menu "Filesystem commands"
1753 bool "Enable the 'btrsubvol' command"
1756 This enables the 'btrsubvol' command to list subvolumes
1757 of a BTRFS filesystem. There are no special commands for
1758 listing BTRFS directories or loading BTRFS files - this
1759 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1760 when BTRFS is enabled (see FS_BTRFS).
1763 bool "Enable the 'cbfs' command"
1766 Define this to enable support for reading from a Coreboot
1767 filesystem. This is a ROM-based filesystem used for accessing files
1768 on systems that use coreboot as the first boot-loader and then load
1769 U-Boot to actually boot the Operating System. Available commands are
1770 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1773 bool "Enable the 'cramfs' command"
1774 depends on FS_CRAMFS
1776 This provides commands for dealing with CRAMFS (Compressed ROM
1777 filesystem). CRAMFS is useful when space is tight since files are
1778 compressed. Two commands are provided:
1780 cramfsls - lists files in a cramfs image
1781 cramfsload - loads a file from a cramfs image
1784 bool "ext2 command support"
1787 Enables EXT2 FS command
1790 bool "ext4 command support"
1793 Enables EXT4 FS command
1795 config CMD_EXT4_WRITE
1797 bool "ext4 write command support"
1800 Enables EXT4 FS write command
1803 bool "FAT command support"
1806 Support for the FAT fs
1808 config CMD_FS_GENERIC
1809 bool "filesystem commands"
1811 Enables filesystem commands (e.g. load, ls) that work for multiple
1815 bool "fsuuid command"
1817 Enables fsuuid command for filesystem UUID.
1820 bool "jffs2 command"
1823 Enables commands to support the JFFS2 (Journalling Flash File System
1824 version 2) filesystem. This enables fsload, ls and fsinfo which
1825 provide the ability to load files, list directories and obtain
1826 filesystem information.
1829 bool "MTD partition support"
1830 select MTD_DEVICE if (CMD_NAND || NAND)
1832 MTD partitioning tool support.
1833 It is strongly encouraged to avoid using this command
1834 anymore along with 'sf', 'nand', 'onenand'. One can still
1835 declare the partitions in the mtdparts environment variable
1836 but better use the MTD stack and the 'mtd' command instead.
1838 config MTDIDS_DEFAULT
1839 string "Default MTD IDs"
1840 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1842 Defines a default MTD IDs list for use with MTD partitions in the
1843 Linux MTD command line partitions format.
1845 config MTDPARTS_DEFAULT
1846 string "Default MTD partition scheme"
1847 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1849 Defines a default MTD partitioning scheme in the Linux MTD command
1850 line partitions format
1852 config CMD_MTDPARTS_SPREAD
1853 bool "Padd partition size to take account of bad blocks"
1854 depends on CMD_MTDPARTS
1856 This enables the 'spread' sub-command of the mtdparts command.
1857 This command will modify the existing mtdparts variable by increasing
1858 the size of the partitions such that 1) each partition's net size is
1859 at least as large as the size specified in the mtdparts variable and
1860 2) each partition starts on a good block.
1863 bool "reiser - Access to reiserfs filesystems"
1865 This provides two commands which operate on a resierfs filesystem,
1866 commonly used some years ago:
1868 reiserls - list files
1869 reiserload - load a file
1872 bool "yaffs2 - Access of YAFFS2 filesystem"
1876 This provides commands for accessing a YAFFS2 filesystem. Yet
1877 Another Flash Filesystem 2 is a filesystem designed specifically
1878 for NAND flash. It incorporates bad-block management and ensures
1879 that device writes are sequential regardless of filesystem
1883 bool "zfs - Access of ZFS filesystem"
1885 This provides commands to accessing a ZFS filesystem, commonly used
1886 on Solaris systems. Two sub-commands are provided:
1888 zfsls - list files in a directory
1889 zfsload - load a file
1891 See doc/README.zfs for more details.
1895 menu "Debug commands"
1900 The bedbug (emBEDded deBUGger) command provides debugging features
1901 for some PowerPC processors. For details please see the
1902 docuemntation in doc/README.beddbug
1905 bool "diag - Board diagnostics"
1907 This command provides access to board diagnostic tests. These are
1908 called Power-on Self Tests (POST). The command allows listing of
1909 available tests and running either all the tests, or specific tests
1913 bool "irq - Show information about interrupts"
1914 depends on !ARM && !MIPS && !SH
1916 This enables two commands:
1918 interrupts - enable or disable interrupts
1919 irqinfo - print device-specific interrupt information
1922 bool "kgdb - Allow debugging of U-Boot with gdb"
1925 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1926 over a serial link for debugging purposes. This allows
1927 single-stepping, inspecting variables, etc. This is supported only
1928 on PowerPC at present.
1931 bool "log - Generation, control and access to logging"
1934 This provides access to logging features. It allows the output of
1935 log data to be controlled to a limited extent (setting up the default
1936 maximum log level for emitting of records). It also provides access
1937 to a command used for testing the log system.
1940 bool "trace - Support tracing of function calls and timing"
1942 Enables a command to control using of function tracing within
1943 U-Boot. This allows recording of call traces including timing
1944 information. The command can write data to memory for exporting
1945 for analysis (e.g. using bootchart). See doc/README.trace for full
1949 bool "avb - Android Verified Boot 2.0 operations"
1950 depends on AVB_VERIFY
1953 Enables a "avb" command to perform verification of partitions using
1954 Android Verified Boot 2.0 functionality. It includes such subcommands:
1955 avb init - initialize avb2 subsystem
1956 avb read_rb - read rollback index
1957 avb write_rb - write rollback index
1958 avb is_unlocked - check device lock state
1959 avb get_uuid - read and print uuid of a partition
1960 avb read_part - read data from partition
1961 avb read_part_hex - read data from partition and output to stdout
1962 avb write_part - write data to partition
1963 avb verify - run full verification chain
1967 tristate "Enable UBI - Unsorted block images commands"
1970 UBI is a software layer above MTD layer which admits use of LVM-like
1971 logical volumes on top of MTD devices, hides some complexities of
1972 flash chips like wear and bad blocks and provides some other useful
1973 capabilities. Please, consult the MTD web site for more details
1974 (www.linux-mtd.infradead.org). Activate this option if you want
1975 to use U-Boot UBI commands.
1976 It is also strongly encouraged to also enable CONFIG_MTD to get full
1980 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1982 default y if CMD_UBI
1985 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob