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 args or dtb for Falcon-mode NAND boot"
329 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
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_NOR_OFS
338 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
339 depends on CMD_SPL && SPL_NOR_SUPPORT
342 This provides the offset of the command line arguments or dtb for
343 Linux when booting from NOR in Falcon mode.
345 config CMD_SPL_WRITE_SIZE
346 hex "Size of argument area"
350 This provides the size of the command-line argument area in NAND
351 flash used by Falcon-mode boot. See the documentation until CMD_SPL
355 bool "fitImage update command"
357 Implements the 'fitupd' command, which allows to automatically
358 store software updates present on a TFTP server in NOR Flash
360 config CMD_THOR_DOWNLOAD
361 bool "thor - TIZEN 'thor' download"
363 Implements the 'thor' download protocol. This is a way of
364 downloading a software update over USB from an attached host.
365 There is no documentation about this within the U-Boot source code
366 but you should be able to find something on the interwebs.
369 bool "zboot - x86 boot command"
371 With x86 machines it is common to boot a bzImage file which
372 contains both a kernel and a setup.bin file. The latter includes
373 configuration information from the dark ages which x86 boards still
374 need to pick things out of.
376 Consider using FIT in preference to this since it supports directly
377 booting both 32- and 64-bit kernels, as well as secure boot.
378 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
382 menu "Environment commands"
385 bool "ask for env variable"
387 Ask for environment variable
405 Edit environment variable.
410 Allow for searching environment variables
416 Save all environment variables into the compiled-in persistent
422 depends on CMD_SAVEENV
424 Erase environment variables from the compiled-in persistent
427 config CMD_ENV_EXISTS
431 Check if a variable is defined in the environment for use in
434 config CMD_ENV_CALLBACK
435 bool "env callbacks - print callbacks and their associated variables"
437 Some environment variable have callbacks defined by
438 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
439 For example changing "baudrate" adjust the serial baud rate. This
440 command lists the currently defined callbacks.
443 bool "env flags -print variables that have non-default flags"
445 Some environment variables have special flags that control their
446 behaviour. For example, serial# can only be written once and cannot
447 be deleted. This command shows the variables that have special
450 config CMD_NVEDIT_EFI
451 bool "env [set|print] -e - set/print UEFI variables"
452 depends on EFI_LOADER
456 UEFI variables are encoded as some form of U-Boot variables.
457 If enabled, we are allowed to set/print UEFI variables using
458 "env" command with "-e" option without knowing details.
460 config CMD_NVEDIT_INFO
461 bool "env info - print or evaluate environment information"
463 Print environment information:
464 - env_valid : is environment valid
465 - env_ready : is environment imported into hash table
466 - env_use_default : is default environment used
468 This command can be optionally used for evaluation in scripts:
469 [-d] : evaluate whether default environment is used
470 [-p] : evaluate whether environment can be persisted
471 The result of multiple evaluations will be combined with AND.
475 menu "Memory commands"
480 Compute binary operations (xor, or, and) of byte arrays of arbitrary
481 size from memory and store the result in memory or the environment.
494 Add -v option to verify data against a crc32 checksum.
497 bool "eeprom - EEPROM subsystem"
499 (deprecated, needs conversion to driver model)
500 Provides commands to read and write EEPROM (Electrically Erasable
501 Programmable Read Only Memory) chips that are connected over an
504 config CMD_EEPROM_LAYOUT
505 bool "Enable layout-aware eeprom commands"
506 depends on CMD_EEPROM
508 (deprecated, needs conversion to driver model)
509 When enabled, additional eeprom sub-commands become available.
511 eeprom print - prints the contents of the eeprom in a human-readable
512 way (eeprom layout fields, and data formatted to be fit for human
515 eeprom update - allows user to update eeprom fields by specifying
516 the field name, and providing the new data in a human readable format
517 (same format as displayed by the eeprom print command).
519 Both commands can either auto detect the layout, or be told which
523 __weak int parse_layout_version(char *str)
524 - override to provide your own layout name parsing
525 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
527 - override to setup the layout metadata based on the version
528 __weak int eeprom_layout_detect(unsigned char *data)
529 - override to provide your own algorithm for detecting layout
532 - contains various printing and updating functions for common
533 types of eeprom fields. Can be used for defining
536 config EEPROM_LAYOUT_HELP_STRING
537 string "Tells user what layout names are supported"
538 depends on CMD_EEPROM_LAYOUT
539 default "<not defined>"
541 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
547 Infinite write loop on address range
554 Compute MD5 checksum.
559 depends on CMD_MD5SUM
561 Add -v option to verify data against an MD5 checksum.
566 Display memory information.
569 bool "md, mm, nm, mw, cp, cmp, base, loop"
574 mm - memory modify (auto-incrementing address)
575 nm - memory modify (constant address)
576 mw - memory write (fill)
579 base - print or set address offset
580 loop - initialize loop on address range
585 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
587 random - fill memory with random data
592 Simple RAM read/write test.
596 config SYS_ALT_MEMTEST
597 bool "Alternative test"
599 Use a more complete alternative memory test.
606 mdc - memory display cyclic
607 mwc - memory write cyclic
613 Compute SHA1 checksum.
615 config SHA1SUM_VERIFY
617 depends on CMD_SHA1SUM
619 Add -v option to verify data against a SHA1 checksum.
622 bool "strings - display strings in memory"
624 This works similarly to the Unix 'strings' command except that it
625 works with a memory range. String of printable characters found
626 within the range are displayed. The minimum number of characters
627 for a sequence to be considered a string can be provided.
631 menu "Compression commands"
635 default y if CMD_BOOTI
638 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
643 default y if CMD_BOOTI
645 Uncompress a zip-compressed memory region.
650 Compress a memory region with zlib deflate method.
654 menu "Device access commands"
657 #depends on FLASH_CFI_DRIVER
660 ARM Ltd reference designs flash partition access
663 bool "adc - Access Analog to Digital Converters info and data"
667 Shows ADC device info and permit printing one-shot analog converted
668 data from a named Analog to Digital Converter.
673 depends on PARTITIONS
675 Read/modify/write the fields of Bootloader Control Block, usually
676 stored on the flash "misc" partition with its structure defined in:
677 https://android.googlesource.com/platform/bootable/recovery/+/master/
678 bootloader_message/include/bootloader_message/bootloader_message.h
680 Some real-life use-cases include (but are not limited to):
681 - Determine the "boot reason" (and act accordingly):
682 https://source.android.com/devices/bootloader/boot-reason
683 - Get/pass a list of commands from/to recovery:
684 https://android.googlesource.com/platform/bootable/recovery
685 - Inspect/dump the contents of the BCB fields
688 bool "bind/unbind - Bind or unbind a device to/from a driver"
691 Bind or unbind a device to/from a driver from the command line.
692 This is useful in situations where a device may be handled by several
693 drivers. For example, this can be used to bind a UDC to the usb ether
694 gadget driver from the command line.
697 bool "clk - Show clock frequencies"
700 Shows clock frequences by calling a sock_clk_dump() hook function.
701 This is depreated in favour of using the CLK uclass and accessing
702 clock values from associated drivers. However currently no command
706 bool "demo - Demonstration commands for driver model"
709 Provides a 'demo' command which can be used to play around with
710 driver model. To use this properly you will need to enable one or
711 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
712 Otherwise you will always get an empty list of devices. The demo
713 devices are defined in the sandbox device tree, so the easiest
714 option is to use sandbox and pass the -d point to sandbox's
721 Enables the command "dfu" which is used to have U-Boot create a DFU
722 class device via USB. This command requires that the "dfu_alt_info"
723 environment variable be set and define the alt settings to expose to
727 bool "dm - Access to driver model information"
730 Provides access to driver model data structures and information,
731 such as a list of devices, list of uclasses and the state of each
732 device (e.g. activated). This is not required for operation, but
733 can be useful to see the state of driver model for debugging or
737 bool "fastboot - Android fastboot support"
740 This enables the command "fastboot" which enables the Android
741 fastboot mode for the platform. Fastboot is a protocol for
742 downloading images, flashing and device control used on
743 Android devices. Fastboot requires either the network stack
744 enabled or support for acting as a USB device.
746 See doc/README.android-fastboot for more information.
749 bool "fdcboot - Boot from floppy device"
751 The 'fdtboot' command allows booting an image from a floppy disk.
754 bool "flinfo, erase, protect"
758 flinfo - print FLASH memory information
760 protect - enable or disable FLASH write protection
769 config CMD_FPGA_LOADBP
770 bool "fpga loadbp - load partial bitstream (Xilinx only)"
773 Supports loading an FPGA device from a bitstream buffer containing
776 config CMD_FPGA_LOADFS
777 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
780 Supports loading an FPGA device from a FAT filesystem.
782 config CMD_FPGA_LOADMK
783 bool "fpga loadmk - load bitstream from image"
786 Supports loading an FPGA device from a image generated by mkimage.
788 config CMD_FPGA_LOADP
789 bool "fpga loadp - load partial bitstream"
792 Supports loading an FPGA device from a bitstream buffer containing
795 config CMD_FPGA_LOAD_SECURE
796 bool "fpga loads - loads secure bitstreams (Xilinx only)"
799 Enables the fpga loads command which is used to load secure
800 (authenticated or encrypted or both) bitstreams on to FPGA.
803 bool "fpgad - dump FPGA registers"
805 (legacy, needs conversion to driver model)
806 Provides a way to dump FPGA registers by calling the board-specific
807 fpga_get_reg() function. This functions similarly to the 'md'
811 bool "fuse - support for the fuse subssystem"
813 (deprecated - needs conversion to driver model)
814 This allows reading, sensing, programming or overriding fuses
815 which control the behaviour of the device. The command uses the
824 bool "GPT (GUID Partition Table) command"
826 select HAVE_BLOCK_DEVICE
827 select PARTITION_UUIDS
830 Enable the 'gpt' command to ready and write GPT style partition
834 bool "GPT Random UUID generation"
837 Enable the generation of partitions with random UUIDs if none
840 config CMD_GPT_RENAME
841 bool "GPT partition renaming commands"
844 Enables the 'gpt' command to interchange names on two GPT
845 partitions via the 'gpt swap' command or to rename single
846 partitions via the 'rename' command.
849 bool "ide - Support for IDE drivers"
852 Provides an 'ide' command which allows accessing the IDE drive,
853 reseting the IDE interface, printing the partition table and
854 geting device info. It also enables the 'diskboot' command which
855 permits booting from an IDE drive.
858 bool "io - Support for performing I/O accesses"
860 Provides an 'iod' command to display I/O space and an 'iow' command
861 to write values to the I/O space. This can be useful for manually
862 checking the state of devices during boot when debugging device
866 bool "iotrace - Support for tracing I/O activity"
868 Provides an 'iotrace' command which supports recording I/O reads and
869 writes in a trace buffer in memory . It also maintains a checksum
870 of the trace records (even if space is exhausted) so that the
871 sequence of I/O accesses can be verified.
873 When debugging drivers it is useful to see what I/O accesses were
874 done and in what order.
876 Even if the individual accesses are of little interest it can be
877 useful to verify that the access pattern is consistent each time
878 an operation is performed. In this case a checksum can be used to
879 characterise the operation of a driver. The checksum can be compared
880 across different runs of the operation to verify that the driver is
883 In particular, when performing major refactoring of the driver, where
884 the access pattern should not change, the checksum provides assurance
885 that the refactoring work has not broken the driver.
887 This works by sneaking into the io.h heder for an architecture and
888 redirecting I/O accesses through iotrace's tracing mechanism.
890 For now no commands are provided to examine the trace buffer. The
891 format is fairly simple, so 'md' is a reasonable substitute.
893 Note: The checksum feature is only useful for I/O regions where the
894 contents do not change outside of software control. Where this is not
895 suitable you can fall back to manually comparing the addresses. It
896 might be useful to enhance tracing to only checksum the accesses and
897 not the data read/written.
907 bool "w1 - Support for Dallas 1-Wire protocol"
909 Dallas 1-wire protocol support
915 Load a binary file over serial line.
921 Load an S-Record file over serial line
926 MMC memory mapped support.
929 bool "Enable support for RPMB in the mmc command"
932 Enable the commands for reading, writing and programming the
933 key for the Replay Protection Memory Block partition in eMMC.
935 config CMD_MMC_SWRITE
937 depends on CMD_MMC && MMC_WRITE
940 Enable support for the "mmc swrite" command to write Android sparse
945 select MTD_PARTITIONS
947 MTD commands support.
951 default y if NAND_SUNXI
956 config CMD_NAND_TRIMFFS
957 bool "nand write.trimffs"
958 default y if ARCH_SUNXI
960 Allows one to skip empty pages when flashing something on a NAND.
962 config CMD_NAND_LOCK_UNLOCK
963 bool "nand lock/unlock"
965 NAND locking support.
967 config CMD_NAND_TORTURE
970 NAND torture support.
979 NVM Express device support
982 bool "onenand - access to onenand device"
984 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
985 various useful features. This command allows reading, writing,
986 and erasing blocks. It allso provides a way to show and change
987 bad blocks, and test the device.
992 Enable the 'osd' command which allows to query information from and
993 write text data to a on-screen display (OSD) device; a virtual device
994 associated with a display capable of displaying a text overlay on the
995 display it's associated with..
999 select HAVE_BLOCK_DEVICE
1000 select PARTITION_UUIDS
1002 Read and display information about the partition table on
1006 bool "pci - Access PCI devices"
1008 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1009 used on some devices to allow the CPU to communicate with its
1010 peripherals. Sub-commands allow bus enumeration, displaying and
1011 changing configuration space and a few other features.
1014 bool "pinit - Set up PCMCIA device"
1016 Provides a means to initialise a PCMCIA (Personal Computer Memory
1017 Card International Association) device. This is an old standard from
1018 about 1990. These devices are typically removable memory or network
1019 cards using a standard 68-pin connector.
1022 bool "pinmux - show pins muxing"
1023 default y if PINCTRL
1025 Parse all available pin-controllers and show pins muxing. This
1026 is useful for debug purpoer to check the pin muxing and to know if
1027 a pin is configured as a GPIO or as an alternate function.
1032 Poweroff/Shutdown the system
1035 bool "read - Read binary data from a partition"
1037 Provides low-level access to the data in a partition.
1039 config CMD_REMOTEPROC
1041 depends on REMOTEPROC
1043 Support for Remote Processor control
1046 bool "sata - Access SATA subsystem"
1049 SATA (Serial Advanced Technology Attachment) is a serial bus
1050 standard for connecting to hard drives and other storage devices.
1051 This command provides information about attached devices and allows
1052 reading, writing and other operations.
1054 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1055 Attachment, where AT refers to an IBM AT (Advanced Technology)
1056 computer released in 1984.
1059 bool "saves - Save a file over serial in S-Record format"
1061 Provides a way to save a binary file using the Motorola S-Record
1062 format over the serial line.
1065 bool "scsi - Access to SCSI devices"
1068 This provides a 'scsi' command which provides access to SCSI (Small
1069 Computer System Interface) devices. The command provides a way to
1070 scan the bus, reset the bus, read and write data and get information
1074 bool "sdram - Print SDRAM configuration information"
1076 Provides information about attached SDRAM. This assumed that the
1077 SDRAM has an EEPROM with information that can be read using the
1078 I2C bus. This is only available on some boards.
1082 depends on DM_SPI_FLASH || SPI_FLASH
1087 bool "sf test - Allow testing of SPI flash"
1090 Provides a way to test that SPI flash is working correctly. The
1091 test is destructive, in that an area of SPI flash must be provided
1092 for the test to use. Performance information is also provided,
1093 measuring the performance of reading, writing and erasing in
1094 Mbps (Million Bits Per Second). This value should approximately
1095 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1096 everything is working properly.
1099 bool "sspi - Command to access spi device"
1102 SPI utility command.
1104 config DEFAULT_SPI_BUS
1105 int "default spi bus used by sspi command"
1109 config DEFAULT_SPI_MODE
1110 hex "default spi mode used by sspi command (see include/spi.h)"
1115 bool "tsi148 - Command to access tsi148 device"
1117 This provides various sub-commands to initialise and configure the
1118 Turndra tsi148 device. See the command help for full details.
1121 bool "universe - Command to set up the Turndra Universe controller"
1123 This allows setting up the VMEbus provided by this controller.
1124 See the command help for full details.
1128 select HAVE_BLOCK_DEVICE
1134 select USB_FUNCTION_SDP
1136 Enables the command "sdp" which is used to have U-Boot emulating the
1137 Serial Download Protocol (SDP) via USB.
1141 depends on USB_FUNCTION_ROCKUSB
1143 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1144 read/write info, image to/from devices. This enable rockusb command
1145 support to communication with rockusb device. for more detail about
1146 this command, please read doc/README.rockusb.
1148 config CMD_USB_MASS_STORAGE
1149 bool "UMS usb mass storage"
1150 select USB_FUNCTION_MASS_STORAGE
1152 USB mass storage support
1159 VirtIO block device support
1165 This provides commands to control the watchdog timer devices.
1171 Enable the command "axi" for accessing AXI (Advanced eXtensible
1172 Interface) busses, a on-chip interconnect specification for managing
1173 functional blocks in SoC designs, which is also often used in designs
1174 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1178 menu "Shell scripting commands"
1184 Echo args to console
1190 Return true/false on integer compare.
1196 Run script from memory
1202 Evaluate boolean and math expressions and store the result in an env
1204 Also supports loading the value at a memory location into a variable.
1205 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1212 bool "Network commands"
1222 bootp - boot image via network using BOOTP/TFTP protocol
1226 depends on CMD_BOOTP
1228 Boot image via network using DHCP/TFTP protocol
1230 config BOOTP_BOOTPATH
1231 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1233 depends on CMD_BOOTP
1235 Even though the config is called BOOTP_BOOTPATH, it stores the
1236 path in the variable 'rootpath'.
1239 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1241 depends on CMD_BOOTP
1243 The primary DNS server is stored as 'dnsip'. If two servers are
1244 returned, you must set BOOTP_DNS2 to store that second server IP
1248 bool "Store 'dnsip2' from BOOTP/DHCP server"
1249 depends on BOOTP_DNS
1251 If a DHCP client requests the DNS server IP from a DHCP server,
1252 it is possible that more than one DNS serverip is offered to the
1253 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1254 server IP will be stored in the additional environment
1255 variable "dnsip2". The first DNS serverip is always
1256 stored in the variable "dnsip", when BOOTP_DNS is defined.
1258 config BOOTP_GATEWAY
1259 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1261 depends on CMD_BOOTP
1263 config BOOTP_HOSTNAME
1264 bool "Request & store 'hostname' from BOOTP/DHCP server"
1266 depends on CMD_BOOTP
1268 The name may or may not be qualified with the local domain name.
1270 config BOOTP_PREFER_SERVERIP
1271 bool "serverip variable takes precedent over DHCP server IP."
1272 depends on CMD_BOOTP
1274 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1276 With this option enabled, the 'serverip' variable in the environment
1277 takes precedence over DHCP server IP and will only be set by the DHCP
1278 server if not already set in the environment.
1280 config BOOTP_SUBNETMASK
1281 bool "Request & store 'netmask' from BOOTP/DHCP server"
1283 depends on CMD_BOOTP
1285 config BOOTP_NTPSERVER
1286 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1287 depends on CMD_BOOTP
1290 bool "Send PXE client arch to BOOTP/DHCP server"
1292 depends on CMD_BOOTP && CMD_PXE
1294 Supported for ARM, ARM64, and x86 for now.
1296 config BOOTP_PXE_CLIENTARCH
1298 depends on BOOTP_PXE
1299 default 0x16 if ARM64
1303 config BOOTP_VCI_STRING
1305 depends on CMD_BOOTP
1306 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1307 default "U-Boot.armv8" if ARM64
1308 default "U-Boot.arm" if ARM
1315 tftpboot - boot image via network using TFTP protocol
1319 depends on CMD_TFTPBOOT
1321 TFTP put command, for uploading files to a server
1325 depends on CMD_TFTPBOOT
1327 Act as a TFTP server and boot the first received file
1329 config NET_TFTP_VARS
1330 bool "Control TFTP timeout and count through environment"
1331 depends on CMD_TFTPBOOT
1334 If set, allows controlling the TFTP timeout through the
1335 environment variable tftptimeout, and the TFTP maximum
1336 timeout count through the variable tftptimeoutcountmax.
1337 If unset, timeout and maximum are hard-defined as 1 second
1338 and 10 timouts per TFTP transfer.
1343 Boot image via network using RARP/TFTP protocol
1349 Boot image via network using NFS protocol.
1354 Enable MII utility commands.
1359 Send ICMP ECHO_REQUEST to network host
1364 Perform CDP network configuration
1369 Synchronize RTC via network
1374 Lookup the IP of a hostname
1376 config CMD_LINK_LOCAL
1380 Acquire a network IP address using the link-local protocol
1387 Allow control of L2 Ethernet switch commands. These are supported
1388 by the vsc9953 Ethernet driver at present. Sub-commands allow
1389 operations such as enabling / disabling a port and
1390 viewing/maintaining the filtering database (FDB)
1396 Boot image via network using PXE protocol
1401 Wait for wake-on-lan Magic Packet
1405 menu "Misc commands"
1408 bool "Enable 'bmp' command"
1409 depends on LCD || DM_VIDEO || VIDEO
1411 This provides a way to obtain information about a BMP-format iamge
1412 and to display it. BMP (which presumably stands for BitMaP) is a
1413 file format defined by Microsoft which supports images of various
1414 depths, formats and compression methods. Headers on the file
1415 determine the formats used. This command can be used by first loading
1416 the image into RAM, then using this command to look at it or display
1419 config CMD_BOOTCOUNT
1421 depends on BOOTCOUNT_LIMIT
1423 Enable the bootcount command, which allows interrogation and
1424 reset of the bootcounter.
1427 bool "Enable board-specific commands"
1429 (deprecated: instead, please define a Kconfig option for each command)
1431 Some boards have board-specific commands which are only enabled
1432 during developemnt and need to be turned off for production. This
1433 option provides a way to control this. The commands that are enabled
1434 vary depending on the board.
1436 config CMD_BKOPS_ENABLE
1437 bool "mmc bkops enable"
1441 Enable command for setting manual background operations handshake
1442 on a eMMC device. The feature is optionally available on eMMC devices
1443 conforming to standard >= 4.41.
1445 config CMD_BLOCK_CACHE
1446 bool "blkcache - control and stats for block cache"
1447 depends on BLOCK_CACHE
1448 default y if BLOCK_CACHE
1450 Enable the blkcache command, which can be used to control the
1451 operation of the cache functions.
1452 This is most useful when fine-tuning the operation of the cache
1453 during development, but also allows the cache to be disabled when
1454 it might hurt performance (e.g. when using the ums command).
1457 bool "icache or dcache"
1459 Enable the "icache" and "dcache" commands
1461 config CMD_CONITRACE
1462 bool "conitrace - trace console input codes"
1464 Enable the 'conitrace' command which displays the codes received
1465 from the console input as hexadecimal numbers.
1468 bool "Enable clear screen command 'cls'"
1469 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1472 Enable the 'cls' command which clears the screen contents
1473 on video frame buffer.
1476 bool "efidebug - display/configure UEFI environment"
1477 depends on EFI_LOADER
1478 select EFI_DEVICE_PATH_TO_TEXT
1481 Enable the 'efidebug' command which provides a subset of UEFI
1482 shell utility with simplified functionality. It will be useful
1483 particularly for managing boot parameters as well as examining
1484 various EFI status for debugging.
1486 config CMD_EXCEPTION
1487 bool "exception - raise exception"
1488 depends on ARM || RISCV || X86
1490 Enable the 'exception' command which allows to raise an exception.
1497 Enable the 'led' command which allows for control of LEDs supported
1498 by the board. The LEDs can be listed with 'led list' and controlled
1499 with led on/off/togle/blink. Any LED drivers can be controlled with
1500 this command, e.g. led_gpio.
1506 Enable the 'date' command for getting/setting the time/date in RTC
1512 Run commands and summarize execution time.
1515 bool "gettime - read elapsed time"
1517 Enable the 'gettime' command which reads the elapsed time since
1518 U-Boot started running. This shows the time in seconds and
1519 milliseconds. See also the 'bootstage' command which provides more
1520 flexibility for boot timing.
1522 # TODO: rename to CMD_SLEEP
1527 Delay execution for some time
1530 bool "support for multiprocessor"
1532 This provides an option to brinup
1533 different processors in multiprocessor
1539 Access the system timer.
1545 This provides basic access to the U-Boot's sound support. The main
1546 feature is to play a beep.
1548 sound init - set up sound system
1549 sound play - play a sound
1555 This provides access to the QEMU firmware interface. The main
1556 feature is to allow easy loading of files passed to qemu-system
1557 via -kernel / -initrd
1559 source "cmd/mvebu/Kconfig"
1562 bool "terminal - provides a way to attach a serial terminal"
1564 Provides a 'cu'-like serial terminal command. This can be used to
1565 access other serial ports from the system console. The terminal
1566 is very simple with no special processing of characters. As with
1567 cu, you can press ~. (tilde followed by period) to exit.
1570 bool "uuid, guid - generation of unique IDs"
1573 This enables two commands:
1575 uuid - generate random Universally Unique Identifier
1576 guid - generate Globally Unique Identifier based on random UUID
1578 The two commands are very similar except for the endianness of the
1583 source "cmd/ti/Kconfig"
1585 config CMD_BOOTSTAGE
1586 bool "Enable the 'bootstage' command"
1587 depends on BOOTSTAGE
1589 Add a 'bootstage' command which supports printing a report
1590 and un/stashing of bootstage data.
1592 menu "Power commands"
1594 bool "Enable Driver Model PMIC command"
1597 This is the pmic command, based on a driver model pmic's API.
1598 Command features are unchanged:
1599 - list - list pmic devices
1600 - pmic dev <id> - show or [set] operating pmic device (NEW)
1601 - pmic dump - dump registers
1602 - pmic read address - read byte of register at address
1603 - pmic write address - write byte to register at address
1604 The only one change for this command is 'dev' subcommand.
1606 config CMD_REGULATOR
1607 bool "Enable Driver Model REGULATOR command"
1608 depends on DM_REGULATOR
1610 This command is based on driver model regulator's API.
1611 User interface features:
1612 - list - list regulator devices
1613 - regulator dev <id> - show or [set] operating regulator device
1614 - regulator info - print constraints info
1615 - regulator status - print operating status
1616 - regulator value <val] <-f> - print/[set] voltage value [uV]
1617 - regulator current <val> - print/[set] current value [uA]
1618 - regulator mode <id> - print/[set] operating mode id
1619 - regulator enable - enable the regulator output
1620 - regulator disable - disable the regulator output
1622 The '-f' (force) option can be used for set the value which exceeds
1623 the limits, which are found in device-tree and are kept in regulator's
1624 uclass platdata structure.
1628 menu "Security commands"
1630 bool "Enable the 'aes' command"
1633 This provides a means to encrypt and decrypt data using the AES
1634 (Advanced Encryption Standard). This algorithm uses a symetric key
1635 and is widely used as a streaming cipher. Different key lengths are
1636 supported by the algorithm but this command only supports 128 bits
1640 bool "Enable the 'blob' command"
1642 This is used with the Freescale secure boot mechanism.
1644 Freescale's SEC block has built-in Blob Protocol which provides
1645 a method for protecting user-defined data across system power
1646 cycles. SEC block protects data in a data structure called a Blob,
1647 which provides both confidentiality and integrity protection.
1649 Encapsulating data as a blob
1650 Each time that the Blob Protocol is used to protect data, a
1651 different randomly generated key is used to encrypt the data.
1652 This random key is itself encrypted using a key which is derived
1653 from SoC's non-volatile secret key and a 16 bit Key identifier.
1654 The resulting encrypted key along with encrypted data is called a
1655 blob. The non-volatile secure key is available for use only during
1658 During decapsulation, the reverse process is performed to get back
1662 blob enc - encapsulating data as a cryptgraphic blob
1663 blob dec - decapsulating cryptgraphic blob to get the data
1667 blob enc src dst len km
1669 Encapsulate and create blob of data $len bytes long
1670 at address $src and store the result at address $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.
1675 blob dec src dst len km
1677 Decapsulate the blob of data at address $src and
1678 store result of $len byte at addr $dst.
1679 $km is the 16 byte key modifier is also required for
1680 generation/use as key for cryptographic operation. Key
1681 modifier should be 16 byte long.
1684 bool "Support 'hash' command"
1687 This provides a way to hash data in memory using various supported
1688 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1689 saved to memory or to an environment variable. It is also possible
1690 to verify a hash against data in memory.
1693 bool "Support the 'hvc' command"
1694 depends on ARM_SMCCC
1696 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1697 development and testing.
1700 bool "Support the 'smc' command"
1701 depends on ARM_SMCCC
1703 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1704 development and testing.
1710 Add -v option to verify data against a hash.
1720 bool "Enable the 'tpm' command"
1721 depends on TPM_V1 || TPM_V2
1722 select CMD_TPM_V1 if TPM_V1
1723 select CMD_TPM_V2 if TPM_V2
1725 This provides a means to talk to a TPM from the command line. A wide
1726 range of commands if provided - see 'tpm help' for details. The
1727 command requires a suitable TPM on your board and the correct driver
1733 bool "Enable the 'tpm test' command"
1736 This provides a a series of tests to confirm that the TPMv1.x is
1737 working correctly. The tests cover initialisation, non-volatile RAM,
1738 extend, global lock and checking that timing is within expectations.
1739 The tests pass correctly on Infineon TPMs but may need to be adjusted
1746 menu "Firmware commands"
1748 bool "Enable crosec command"
1752 Enable command-line access to the Chrome OS EC (Embedded
1753 Controller). This provides the 'crosec' command which has
1754 a number of sub-commands for performing EC tasks such as
1755 updating its flash, accessing a small saved context area
1756 and talking to the I2C bus behind the EC (if there is one).
1759 menu "Filesystem commands"
1761 bool "Enable the 'btrsubvol' command"
1764 This enables the 'btrsubvol' command to list subvolumes
1765 of a BTRFS filesystem. There are no special commands for
1766 listing BTRFS directories or loading BTRFS files - this
1767 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1768 when BTRFS is enabled (see FS_BTRFS).
1771 bool "Enable the 'cbfs' command"
1774 Define this to enable support for reading from a Coreboot
1775 filesystem. This is a ROM-based filesystem used for accessing files
1776 on systems that use coreboot as the first boot-loader and then load
1777 U-Boot to actually boot the Operating System. Available commands are
1778 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1781 bool "Enable the 'cramfs' command"
1782 depends on FS_CRAMFS
1784 This provides commands for dealing with CRAMFS (Compressed ROM
1785 filesystem). CRAMFS is useful when space is tight since files are
1786 compressed. Two commands are provided:
1788 cramfsls - lists files in a cramfs image
1789 cramfsload - loads a file from a cramfs image
1792 bool "ext2 command support"
1795 Enables EXT2 FS command
1798 bool "ext4 command support"
1801 Enables EXT4 FS command
1803 config CMD_EXT4_WRITE
1805 bool "ext4 write command support"
1808 Enables EXT4 FS write command
1811 bool "FAT command support"
1814 Support for the FAT fs
1816 config CMD_FS_GENERIC
1817 bool "filesystem commands"
1819 Enables filesystem commands (e.g. load, ls) that work for multiple
1823 bool "fsuuid command"
1825 Enables fsuuid command for filesystem UUID.
1828 bool "jffs2 command"
1831 Enables commands to support the JFFS2 (Journalling Flash File System
1832 version 2) filesystem. This enables fsload, ls and fsinfo which
1833 provide the ability to load files, list directories and obtain
1834 filesystem information.
1837 bool "MTD partition support"
1838 select MTD_DEVICE if (CMD_NAND || NAND)
1840 MTD partitioning tool support.
1841 It is strongly encouraged to avoid using this command
1842 anymore along with 'sf', 'nand', 'onenand'. One can still
1843 declare the partitions in the mtdparts environment variable
1844 but better use the MTD stack and the 'mtd' command instead.
1846 config MTDIDS_DEFAULT
1847 string "Default MTD IDs"
1848 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1850 Defines a default MTD IDs list for use with MTD partitions in the
1851 Linux MTD command line partitions format.
1853 config MTDPARTS_DEFAULT
1854 string "Default MTD partition scheme"
1855 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1857 Defines a default MTD partitioning scheme in the Linux MTD command
1858 line partitions format
1860 config CMD_MTDPARTS_SPREAD
1861 bool "Padd partition size to take account of bad blocks"
1862 depends on CMD_MTDPARTS
1864 This enables the 'spread' sub-command of the mtdparts command.
1865 This command will modify the existing mtdparts variable by increasing
1866 the size of the partitions such that 1) each partition's net size is
1867 at least as large as the size specified in the mtdparts variable and
1868 2) each partition starts on a good block.
1871 bool "reiser - Access to reiserfs filesystems"
1873 This provides two commands which operate on a resierfs filesystem,
1874 commonly used some years ago:
1876 reiserls - list files
1877 reiserload - load a file
1880 bool "yaffs2 - Access of YAFFS2 filesystem"
1884 This provides commands for accessing a YAFFS2 filesystem. Yet
1885 Another Flash Filesystem 2 is a filesystem designed specifically
1886 for NAND flash. It incorporates bad-block management and ensures
1887 that device writes are sequential regardless of filesystem
1891 bool "zfs - Access of ZFS filesystem"
1893 This provides commands to accessing a ZFS filesystem, commonly used
1894 on Solaris systems. Two sub-commands are provided:
1896 zfsls - list files in a directory
1897 zfsload - load a file
1899 See doc/README.zfs for more details.
1903 menu "Debug commands"
1908 The bedbug (emBEDded deBUGger) command provides debugging features
1909 for some PowerPC processors. For details please see the
1910 docuemntation in doc/README.beddbug
1913 bool "diag - Board diagnostics"
1915 This command provides access to board diagnostic tests. These are
1916 called Power-on Self Tests (POST). The command allows listing of
1917 available tests and running either all the tests, or specific tests
1921 bool "irq - Show information about interrupts"
1922 depends on !ARM && !MIPS && !SH
1924 This enables two commands:
1926 interrupts - enable or disable interrupts
1927 irqinfo - print device-specific interrupt information
1930 bool "kgdb - Allow debugging of U-Boot with gdb"
1933 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1934 over a serial link for debugging purposes. This allows
1935 single-stepping, inspecting variables, etc. This is supported only
1936 on PowerPC at present.
1939 bool "log - Generation, control and access to logging"
1942 This provides access to logging features. It allows the output of
1943 log data to be controlled to a limited extent (setting up the default
1944 maximum log level for emitting of records). It also provides access
1945 to a command used for testing the log system.
1948 bool "trace - Support tracing of function calls and timing"
1950 Enables a command to control using of function tracing within
1951 U-Boot. This allows recording of call traces including timing
1952 information. The command can write data to memory for exporting
1953 for analysis (e.g. using bootchart). See doc/README.trace for full
1957 bool "avb - Android Verified Boot 2.0 operations"
1958 depends on AVB_VERIFY
1961 Enables a "avb" command to perform verification of partitions using
1962 Android Verified Boot 2.0 functionality. It includes such subcommands:
1963 avb init - initialize avb2 subsystem
1964 avb read_rb - read rollback index
1965 avb write_rb - write rollback index
1966 avb is_unlocked - check device lock state
1967 avb get_uuid - read and print uuid of a partition
1968 avb read_part - read data from partition
1969 avb read_part_hex - read data from partition and output to stdout
1970 avb write_part - write data to partition
1971 avb verify - run full verification chain
1975 tristate "Enable UBI - Unsorted block images commands"
1978 UBI is a software layer above MTD layer which admits use of LVM-like
1979 logical volumes on top of MTD devices, hides some complexities of
1980 flash chips like wear and bad blocks and provides some other useful
1981 capabilities. Please, consult the MTD web site for more details
1982 (www.linux-mtd.infradead.org). Activate this option if you want
1983 to use U-Boot UBI commands.
1984 It is also strongly encouraged to also enable CONFIG_MTD to get full
1988 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1990 default y if CMD_UBI
1993 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob