1 menu "Command line interface"
4 bool "Support U-Boot commands"
7 Enable U-Boot's command-line functions. This provides a means
8 to enter commands into U-Boot for a wide variety of purposes. It
9 also allows scripts (containing commands) to be executed.
10 Various commands and command categorys can be indivdually enabled.
11 Depending on the number of commands enabled, this can add
12 substantially to the size of U-Boot.
18 This option enables the "hush" shell (from Busybox) as command line
19 interpreter, thus enabling powerful command line syntax like
20 if...then...else...fi conditionals or `&&' and '||'
21 constructs ("shell scripts").
23 If disabled, you get the old, much simpler behaviour with a somewhat
24 smaller memory footprint.
26 config CMDLINE_EDITING
27 bool "Enable command line editing"
31 Enable editing and History functions for interactive command line
35 bool "Enable auto complete using TAB"
39 Enable auto completion of commands using TAB.
42 bool "Enable long help messages"
46 Defined when you want long help messages included
47 Do not set this option when short of memory.
53 This string is displayed in the command line to the left of the
57 string "Command execution tracer"
61 This option enables the possiblity to print all commands before
62 executing them and after all variables are evaluated (similar
63 to Bash's xtrace/'set -x' feature).
64 To enable the tracer a variable "xtrace" needs to be defined in
67 menu "Autoboot options"
73 This enables the autoboot. See doc/README.autoboot for detail.
76 bool "Stop autobooting via specific input key / string"
79 This option enables stopping (aborting) of the automatic
80 boot feature only by issuing a specific input key or
81 string. If not enabled, any input key will abort the
82 U-Boot automatic booting process and bring the device
83 to the U-Boot prompt for user input.
85 config AUTOBOOT_PROMPT
86 string "Autoboot stop prompt"
87 depends on AUTOBOOT_KEYED
88 default "Autoboot in %d seconds\\n"
90 This string is displayed before the boot delay selected by
91 CONFIG_BOOTDELAY starts. If it is not defined there is no
92 output indicating that autoboot is in progress.
94 Note that this define is used as the (only) argument to a
95 printf() call, so it may contain '%' format specifications,
96 provided that it also includes, sepearated by commas exactly
97 like in a printf statement, the required arguments. It is
98 the responsibility of the user to select only such arguments
99 that are valid in the given context.
101 config AUTOBOOT_ENCRYPTION
102 bool "Enable encryption in autoboot stopping"
103 depends on AUTOBOOT_KEYED
105 This option allows a string to be entered into U-Boot to stop the
106 autoboot. The string itself is hashed and compared against the hash
107 in the environment variable 'bootstopkeysha256'. If it matches then
108 boot stops and a command-line prompt is presented.
110 This provides a way to ship a secure production device which can also
111 be accessed at the U-Boot command line.
113 config AUTOBOOT_DELAY_STR
114 string "Delay autobooting via specific input key / string"
115 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
117 This option delays the automatic boot feature by issuing
118 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
119 or the environment variable "bootdelaykey" is specified
120 and this string is received from console input before
121 autoboot starts booting, U-Boot gives a command prompt. The
122 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
123 used, otherwise it never times out.
125 config AUTOBOOT_STOP_STR
126 string "Stop autobooting via specific input key / string"
127 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
129 This option enables stopping (aborting) of the automatic
130 boot feature only by issuing a specific input key or
131 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
132 variable "bootstopkey" is specified and this string is
133 received from console input before autoboot starts booting,
134 U-Boot gives a command prompt. The U-Boot prompt never
135 times out, even if CONFIG_BOOT_RETRY_TIME is used.
137 config AUTOBOOT_KEYED_CTRLC
138 bool "Enable Ctrl-C autoboot interruption"
139 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
142 This option allows for the boot sequence to be interrupted
143 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
144 Setting this variable provides an escape sequence from the
145 limited "password" strings.
147 config AUTOBOOT_STOP_STR_SHA256
148 string "Stop autobooting via SHA256 encrypted password"
149 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
151 This option adds the feature to only stop the autobooting,
152 and therefore boot into the U-Boot prompt, when the input
153 string / password matches a values that is encypted via
154 a SHA256 hash and saved in the environment.
156 config AUTOBOOT_USE_MENUKEY
157 bool "Allow a specify key to run a menu from the environment"
158 depends on !AUTOBOOT_KEYED
160 If a specific key is pressed to stop autoboot, then the commands in
161 the environment variable 'menucmd' are executed before boot starts.
163 config AUTOBOOT_MENUKEY
164 int "ASCII value of boot key to show a menu"
166 depends on AUTOBOOT_USE_MENUKEY
168 If this key is pressed to stop autoboot, then the commands in the
169 environment variable 'menucmd' will be executed before boot starts.
170 For example, 33 means "!" in ASCII, so pressing ! at boot would take
173 config AUTOBOOT_MENU_SHOW
174 bool "Show a menu on boot"
176 This enables the boot menu, controlled by environment variables
177 defined by the board. The menu starts after running the 'preboot'
178 environmnent variable (if enabled) and before handling the boot delay.
179 See README.bootmenu for more details.
201 Print ".config" contents.
203 If this option is enabled, the ".config" file contents are embedded
204 in the U-Boot image and can be printed on the console by the "config"
205 command. This provides information of which options are enabled on
212 Print console devices and information.
217 Print information about available CPUs. This normally shows the
218 number of CPUs, type (e.g. manufacturer, architecture, product or
219 internal name) and clock frequency. Other information may be
220 available depending on the CPU driver.
226 Print GPL license text
242 Run the command stored in the environment "bootcmd", i.e.
243 "bootd" does the same thing as "run bootcmd".
249 Boot an application image from the memory.
254 Boot the Linux zImage
258 depends on ARM64 || RISCV
261 Boot an AArch64 Linux Kernel image from memory.
265 depends on EFI_LOADER
268 Boot an EFI image from memory.
270 config CMD_BOOTEFI_HELLO_COMPILE
271 bool "Compile a standard EFI hello world binary for testing"
272 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
275 This compiles a standard EFI hello world application with U-Boot so
276 that it can be used with the test/py testing framework. This is useful
277 for testing that EFI is working at a basic level, and for bringing
278 up EFI support on a new architecture.
280 No additional space will be required in the resulting U-Boot binary
281 when this option is enabled.
283 config CMD_BOOTEFI_HELLO
284 bool "Allow booting a standard EFI hello world for testing"
285 depends on CMD_BOOTEFI_HELLO_COMPILE
287 This adds a standard EFI hello world application to U-Boot so that
288 it can be used with the 'bootefi hello' command. This is useful
289 for testing that EFI is working at a basic level, and for bringing
290 up EFI support on a new architecture.
292 source lib/efi_selftest/Kconfig
298 Add an ANSI terminal boot menu command.
303 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
304 image into RAM, dump image structure information, etc. Those dtb/dtbo
305 files should be merged in one dtb further, which needs to be passed to
306 the kernel, as part of a boot process.
309 bool "bootelf, bootvx"
312 Boot an ELF/vxWorks image from the memory.
315 bool "Flattened Device Tree utility commands"
319 Do FDT related setup before booting into the Operating System.
325 Start an application at a given address.
331 Run the command in the given environment variable.
337 Print header information for application image.
342 List all images found in flash
348 Extract a part of a multi-image.
351 bool "spl export - Export boot information for Falcon boot"
354 Falcon mode allows booting directly from SPL into an Operating
355 System such as Linux, thus skipping U-Boot proper. See
356 doc/README.falcon for full information about how to use this
359 config CMD_SPL_NAND_OFS
360 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
361 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
364 This provides the offset of the command line arguments for Linux
365 when booting from NAND in Falcon mode. See doc/README.falcon
366 for full information about how to use this option (and also see
367 board/gateworks/gw_ventana/README for an example).
369 config CMD_SPL_NOR_OFS
370 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
371 depends on CMD_SPL && SPL_NOR_SUPPORT
374 This provides the offset of the command line arguments or dtb for
375 Linux when booting from NOR in Falcon mode.
377 config CMD_SPL_WRITE_SIZE
378 hex "Size of argument area"
382 This provides the size of the command-line argument area in NAND
383 flash used by Falcon-mode boot. See the documentation until CMD_SPL
387 bool "fitImage update command"
389 Implements the 'fitupd' command, which allows to automatically
390 store software updates present on a TFTP server in NOR Flash
392 config CMD_THOR_DOWNLOAD
393 bool "thor - TIZEN 'thor' download"
395 Implements the 'thor' download protocol. This is a way of
396 downloading a software update over USB from an attached host.
397 There is no documentation about this within the U-Boot source code
398 but you should be able to find something on the interwebs.
401 bool "zboot - x86 boot command"
403 With x86 machines it is common to boot a bzImage file which
404 contains both a kernel and a setup.bin file. The latter includes
405 configuration information from the dark ages which x86 boards still
406 need to pick things out of.
408 Consider using FIT in preference to this since it supports directly
409 booting both 32- and 64-bit kernels, as well as secure boot.
410 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
414 menu "Environment commands"
417 bool "ask for env variable"
419 Ask for environment variable
437 Edit environment variable.
442 Allow for searching environment variables
448 Save all environment variables into the compiled-in persistent
454 depends on CMD_SAVEENV
456 Erase environment variables from the compiled-in persistent
459 config CMD_ENV_EXISTS
463 Check if a variable is defined in the environment for use in
466 config CMD_ENV_CALLBACK
467 bool "env callbacks - print callbacks and their associated variables"
469 Some environment variable have callbacks defined by
470 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
471 For example changing "baudrate" adjust the serial baud rate. This
472 command lists the currently defined callbacks.
475 bool "env flags -print variables that have non-default flags"
477 Some environment variables have special flags that control their
478 behaviour. For example, serial# can only be written once and cannot
479 be deleted. This command shows the variables that have special
482 config CMD_NVEDIT_EFI
483 bool "env [set|print] -e - set/print UEFI variables"
484 depends on EFI_LOADER
488 UEFI variables are encoded as some form of U-Boot variables.
489 If enabled, we are allowed to set/print UEFI variables using
490 "env" command with "-e" option without knowing details.
492 config CMD_NVEDIT_INFO
493 bool "env info - print or evaluate environment information"
495 Print environment information:
496 - env_valid : is environment valid
497 - env_ready : is environment imported into hash table
498 - env_use_default : is default environment used
500 This command can be optionally used for evaluation in scripts:
501 [-d] : evaluate whether default environment is used
502 [-p] : evaluate whether environment can be persisted
503 The result of multiple evaluations will be combined with AND.
507 menu "Memory commands"
512 Compute binary operations (xor, or, and) of byte arrays of arbitrary
513 size from memory and store the result in memory or the environment.
526 Add -v option to verify data against a crc32 checksum.
529 bool "eeprom - EEPROM subsystem"
531 (deprecated, needs conversion to driver model)
532 Provides commands to read and write EEPROM (Electrically Erasable
533 Programmable Read Only Memory) chips that are connected over an
536 config CMD_EEPROM_LAYOUT
537 bool "Enable layout-aware eeprom commands"
538 depends on CMD_EEPROM
540 (deprecated, needs conversion to driver model)
541 When enabled, additional eeprom sub-commands become available.
543 eeprom print - prints the contents of the eeprom in a human-readable
544 way (eeprom layout fields, and data formatted to be fit for human
547 eeprom update - allows user to update eeprom fields by specifying
548 the field name, and providing the new data in a human readable format
549 (same format as displayed by the eeprom print command).
551 Both commands can either auto detect the layout, or be told which
555 __weak int parse_layout_version(char *str)
556 - override to provide your own layout name parsing
557 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
559 - override to setup the layout metadata based on the version
560 __weak int eeprom_layout_detect(unsigned char *data)
561 - override to provide your own algorithm for detecting layout
564 - contains various printing and updating functions for common
565 types of eeprom fields. Can be used for defining
568 config EEPROM_LAYOUT_HELP_STRING
569 string "Tells user what layout names are supported"
570 depends on CMD_EEPROM_LAYOUT
571 default "<not defined>"
573 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
579 Infinite write loop on address range
586 Compute MD5 checksum.
591 depends on CMD_MD5SUM
593 Add -v option to verify data against an MD5 checksum.
598 Display memory information.
601 bool "md, mm, nm, mw, cp, cmp, base, loop"
606 mm - memory modify (auto-incrementing address)
607 nm - memory modify (constant address)
608 mw - memory write (fill)
611 base - print or set address offset
612 loop - initialize loop on address range
617 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
619 random - fill memory with random data
624 Simple RAM read/write test.
628 config SYS_ALT_MEMTEST
629 bool "Alternative test"
631 Use a more complete alternative memory test.
638 mdc - memory display cyclic
639 mwc - memory write cyclic
645 Compute SHA1 checksum.
647 config SHA1SUM_VERIFY
649 depends on CMD_SHA1SUM
651 Add -v option to verify data against a SHA1 checksum.
654 bool "strings - display strings in memory"
656 This works similarly to the Unix 'strings' command except that it
657 works with a memory range. String of printable characters found
658 within the range are displayed. The minimum number of characters
659 for a sequence to be considered a string can be provided.
663 menu "Compression commands"
667 default y if CMD_BOOTI
670 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
675 default y if CMD_BOOTI
677 Uncompress a zip-compressed memory region.
682 Compress a memory region with zlib deflate method.
686 menu "Device access commands"
689 #depends on FLASH_CFI_DRIVER
692 ARM Ltd reference designs flash partition access
695 bool "adc - Access Analog to Digital Converters info and data"
699 Shows ADC device info and permit printing one-shot analog converted
700 data from a named Analog to Digital Converter.
705 depends on PARTITIONS
707 Read/modify/write the fields of Bootloader Control Block, usually
708 stored on the flash "misc" partition with its structure defined in:
709 https://android.googlesource.com/platform/bootable/recovery/+/master/
710 bootloader_message/include/bootloader_message/bootloader_message.h
712 Some real-life use-cases include (but are not limited to):
713 - Determine the "boot reason" (and act accordingly):
714 https://source.android.com/devices/bootloader/boot-reason
715 - Get/pass a list of commands from/to recovery:
716 https://android.googlesource.com/platform/bootable/recovery
717 - Inspect/dump the contents of the BCB fields
720 bool "bind/unbind - Bind or unbind a device to/from a driver"
723 Bind or unbind a device to/from a driver from the command line.
724 This is useful in situations where a device may be handled by several
725 drivers. For example, this can be used to bind a UDC to the usb ether
726 gadget driver from the command line.
729 bool "clk - Show clock frequencies"
732 Shows clock frequences by calling a sock_clk_dump() hook function.
733 This is depreated in favour of using the CLK uclass and accessing
734 clock values from associated drivers. However currently no command
738 bool "demo - Demonstration commands for driver model"
741 Provides a 'demo' command which can be used to play around with
742 driver model. To use this properly you will need to enable one or
743 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
744 Otherwise you will always get an empty list of devices. The demo
745 devices are defined in the sandbox device tree, so the easiest
746 option is to use sandbox and pass the -d point to sandbox's
753 Enables the command "dfu" which is used to have U-Boot create a DFU
754 class device via USB. This command requires that the "dfu_alt_info"
755 environment variable be set and define the alt settings to expose to
759 bool "dm - Access to driver model information"
762 Provides access to driver model data structures and information,
763 such as a list of devices, list of uclasses and the state of each
764 device (e.g. activated). This is not required for operation, but
765 can be useful to see the state of driver model for debugging or
769 bool "fastboot - Android fastboot support"
772 This enables the command "fastboot" which enables the Android
773 fastboot mode for the platform. Fastboot is a protocol for
774 downloading images, flashing and device control used on
775 Android devices. Fastboot requires either the network stack
776 enabled or support for acting as a USB device.
778 See doc/android/fastboot.txt for more information.
781 bool "fdcboot - Boot from floppy device"
783 The 'fdtboot' command allows booting an image from a floppy disk.
786 bool "flinfo, erase, protect"
790 flinfo - print FLASH memory information
792 protect - enable or disable FLASH write protection
801 config CMD_FPGA_LOADBP
802 bool "fpga loadbp - load partial bitstream (Xilinx only)"
805 Supports loading an FPGA device from a bitstream buffer containing
808 config CMD_FPGA_LOADFS
809 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
812 Supports loading an FPGA device from a FAT filesystem.
814 config CMD_FPGA_LOADMK
815 bool "fpga loadmk - load bitstream from image"
818 Supports loading an FPGA device from a image generated by mkimage.
820 config CMD_FPGA_LOADP
821 bool "fpga loadp - load partial bitstream"
824 Supports loading an FPGA device from a bitstream buffer containing
827 config CMD_FPGA_LOAD_SECURE
828 bool "fpga loads - loads secure bitstreams (Xilinx only)"
831 Enables the fpga loads command which is used to load secure
832 (authenticated or encrypted or both) bitstreams on to FPGA.
835 bool "fpgad - dump FPGA registers"
837 (legacy, needs conversion to driver model)
838 Provides a way to dump FPGA registers by calling the board-specific
839 fpga_get_reg() function. This functions similarly to the 'md'
843 bool "fuse - support for the fuse subssystem"
845 (deprecated - needs conversion to driver model)
846 This allows reading, sensing, programming or overriding fuses
847 which control the behaviour of the device. The command uses the
856 bool "GPT (GUID Partition Table) command"
858 select HAVE_BLOCK_DEVICE
859 select PARTITION_UUIDS
862 Enable the 'gpt' command to ready and write GPT style partition
866 bool "GPT Random UUID generation"
869 Enable the generation of partitions with random UUIDs if none
872 config CMD_GPT_RENAME
873 bool "GPT partition renaming commands"
876 Enables the 'gpt' command to interchange names on two GPT
877 partitions via the 'gpt swap' command or to rename single
878 partitions via the 'rename' command.
881 bool "ide - Support for IDE drivers"
884 Provides an 'ide' command which allows accessing the IDE drive,
885 reseting the IDE interface, printing the partition table and
886 geting device info. It also enables the 'diskboot' command which
887 permits booting from an IDE drive.
890 bool "io - Support for performing I/O accesses"
892 Provides an 'iod' command to display I/O space and an 'iow' command
893 to write values to the I/O space. This can be useful for manually
894 checking the state of devices during boot when debugging device
898 bool "iotrace - Support for tracing I/O activity"
900 Provides an 'iotrace' command which supports recording I/O reads and
901 writes in a trace buffer in memory . It also maintains a checksum
902 of the trace records (even if space is exhausted) so that the
903 sequence of I/O accesses can be verified.
905 When debugging drivers it is useful to see what I/O accesses were
906 done and in what order.
908 Even if the individual accesses are of little interest it can be
909 useful to verify that the access pattern is consistent each time
910 an operation is performed. In this case a checksum can be used to
911 characterise the operation of a driver. The checksum can be compared
912 across different runs of the operation to verify that the driver is
915 In particular, when performing major refactoring of the driver, where
916 the access pattern should not change, the checksum provides assurance
917 that the refactoring work has not broken the driver.
919 This works by sneaking into the io.h heder for an architecture and
920 redirecting I/O accesses through iotrace's tracing mechanism.
922 For now no commands are provided to examine the trace buffer. The
923 format is fairly simple, so 'md' is a reasonable substitute.
925 Note: The checksum feature is only useful for I/O regions where the
926 contents do not change outside of software control. Where this is not
927 suitable you can fall back to manually comparing the addresses. It
928 might be useful to enhance tracing to only checksum the accesses and
929 not the data read/written.
939 bool "w1 - Support for Dallas 1-Wire protocol"
941 Dallas 1-wire protocol support
947 Load a binary file over serial line.
953 Load an S-Record file over serial line
958 MMC memory mapped support.
961 bool "Enable support for RPMB in the mmc command"
964 Enable the commands for reading, writing and programming the
965 key for the Replay Protection Memory Block partition in eMMC.
967 config CMD_MMC_SWRITE
969 depends on CMD_MMC && MMC_WRITE
972 Enable support for the "mmc swrite" command to write Android sparse
977 select MTD_PARTITIONS
979 MTD commands support.
983 default y if NAND_SUNXI
988 config CMD_NAND_TRIMFFS
989 bool "nand write.trimffs"
990 default y if ARCH_SUNXI
992 Allows one to skip empty pages when flashing something on a NAND.
994 config CMD_NAND_LOCK_UNLOCK
995 bool "nand lock/unlock"
997 NAND locking support.
999 config CMD_NAND_TORTURE
1002 NAND torture support.
1011 NVM Express device support
1014 bool "onenand - access to onenand device"
1016 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1017 various useful features. This command allows reading, writing,
1018 and erasing blocks. It allso provides a way to show and change
1019 bad blocks, and test the device.
1024 Enable the 'osd' command which allows to query information from and
1025 write text data to a on-screen display (OSD) device; a virtual device
1026 associated with a display capable of displaying a text overlay on the
1027 display it's associated with..
1031 select HAVE_BLOCK_DEVICE
1032 select PARTITION_UUIDS
1034 Read and display information about the partition table on
1038 bool "pci - Access PCI devices"
1040 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1041 used on some devices to allow the CPU to communicate with its
1042 peripherals. Sub-commands allow bus enumeration, displaying and
1043 changing configuration space and a few other features.
1046 bool "pinit - Set up PCMCIA device"
1048 Provides a means to initialise a PCMCIA (Personal Computer Memory
1049 Card International Association) device. This is an old standard from
1050 about 1990. These devices are typically removable memory or network
1051 cards using a standard 68-pin connector.
1054 bool "pinmux - show pins muxing"
1055 default y if PINCTRL
1057 Parse all available pin-controllers and show pins muxing. This
1058 is useful for debug purpoer to check the pin muxing and to know if
1059 a pin is configured as a GPIO or as an alternate function.
1064 Poweroff/Shutdown the system
1067 bool "read - Read binary data from a partition"
1069 Provides low-level access to the data in a partition.
1071 config CMD_REMOTEPROC
1073 depends on REMOTEPROC
1075 Support for Remote Processor control
1078 bool "sata - Access SATA subsystem"
1081 SATA (Serial Advanced Technology Attachment) is a serial bus
1082 standard for connecting to hard drives and other storage devices.
1083 This command provides information about attached devices and allows
1084 reading, writing and other operations.
1086 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1087 Attachment, where AT refers to an IBM AT (Advanced Technology)
1088 computer released in 1984.
1091 bool "saves - Save a file over serial in S-Record format"
1093 Provides a way to save a binary file using the Motorola S-Record
1094 format over the serial line.
1097 bool "scsi - Access to SCSI devices"
1100 This provides a 'scsi' command which provides access to SCSI (Small
1101 Computer System Interface) devices. The command provides a way to
1102 scan the bus, reset the bus, read and write data and get information
1106 bool "sdram - Print SDRAM configuration information"
1108 Provides information about attached SDRAM. This assumed that the
1109 SDRAM has an EEPROM with information that can be read using the
1110 I2C bus. This is only available on some boards.
1114 depends on DM_SPI_FLASH || SPI_FLASH
1119 bool "sf test - Allow testing of SPI flash"
1122 Provides a way to test that SPI flash is working correctly. The
1123 test is destructive, in that an area of SPI flash must be provided
1124 for the test to use. Performance information is also provided,
1125 measuring the performance of reading, writing and erasing in
1126 Mbps (Million Bits Per Second). This value should approximately
1127 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1128 everything is working properly.
1131 bool "sspi - Command to access spi device"
1134 SPI utility command.
1136 config DEFAULT_SPI_BUS
1137 int "default spi bus used by sspi command"
1141 config DEFAULT_SPI_MODE
1142 hex "default spi mode used by sspi command (see include/spi.h)"
1147 bool "tsi148 - Command to access tsi148 device"
1149 This provides various sub-commands to initialise and configure the
1150 Turndra tsi148 device. See the command help for full details.
1153 bool "universe - Command to set up the Turndra Universe controller"
1155 This allows setting up the VMEbus provided by this controller.
1156 See the command help for full details.
1160 select HAVE_BLOCK_DEVICE
1166 select USB_FUNCTION_SDP
1168 Enables the command "sdp" which is used to have U-Boot emulating the
1169 Serial Download Protocol (SDP) via USB.
1173 depends on USB_FUNCTION_ROCKUSB
1175 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1176 read/write info, image to/from devices. This enable rockusb command
1177 support to communication with rockusb device. for more detail about
1178 this command, please read doc/README.rockusb.
1180 config CMD_USB_MASS_STORAGE
1181 bool "UMS usb mass storage"
1182 select USB_FUNCTION_MASS_STORAGE
1184 USB mass storage support
1191 VirtIO block device support
1197 This provides commands to control the watchdog timer devices.
1203 Enable the command "axi" for accessing AXI (Advanced eXtensible
1204 Interface) busses, a on-chip interconnect specification for managing
1205 functional blocks in SoC designs, which is also often used in designs
1206 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1210 menu "Shell scripting commands"
1216 Echo args to console
1222 Return true/false on integer compare.
1228 Run script from memory
1234 Evaluate boolean and math expressions and store the result in an env
1236 Also supports loading the value at a memory location into a variable.
1237 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1241 menu "Android support commands"
1243 config CMD_AB_SELECT
1246 depends on ANDROID_AB
1248 On Android devices with more than one boot slot (multiple copies of
1249 the kernel and system images) this provides a command to select which
1250 slot should be used to boot from and register the boot attempt. This
1251 is used by the new A/B update model where one slot is updated in the
1252 background while running from the other slot.
1259 bool "Network commands"
1269 bootp - boot image via network using BOOTP/TFTP protocol
1273 depends on CMD_BOOTP
1275 Boot image via network using DHCP/TFTP protocol
1277 config BOOTP_BOOTPATH
1278 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1280 depends on CMD_BOOTP
1282 Even though the config is called BOOTP_BOOTPATH, it stores the
1283 path in the variable 'rootpath'.
1286 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1288 depends on CMD_BOOTP
1290 The primary DNS server is stored as 'dnsip'. If two servers are
1291 returned, you must set BOOTP_DNS2 to store that second server IP
1295 bool "Store 'dnsip2' from BOOTP/DHCP server"
1296 depends on BOOTP_DNS
1298 If a DHCP client requests the DNS server IP from a DHCP server,
1299 it is possible that more than one DNS serverip is offered to the
1300 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1301 server IP will be stored in the additional environment
1302 variable "dnsip2". The first DNS serverip is always
1303 stored in the variable "dnsip", when BOOTP_DNS is defined.
1305 config BOOTP_GATEWAY
1306 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1308 depends on CMD_BOOTP
1310 config BOOTP_HOSTNAME
1311 bool "Request & store 'hostname' from BOOTP/DHCP server"
1313 depends on CMD_BOOTP
1315 The name may or may not be qualified with the local domain name.
1317 config BOOTP_PREFER_SERVERIP
1318 bool "serverip variable takes precedent over DHCP server IP."
1319 depends on CMD_BOOTP
1321 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1323 With this option enabled, the 'serverip' variable in the environment
1324 takes precedence over DHCP server IP and will only be set by the DHCP
1325 server if not already set in the environment.
1327 config BOOTP_SUBNETMASK
1328 bool "Request & store 'netmask' from BOOTP/DHCP server"
1330 depends on CMD_BOOTP
1332 config BOOTP_NTPSERVER
1333 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1334 depends on CMD_BOOTP
1337 bool "Send PXE client arch to BOOTP/DHCP server"
1339 depends on CMD_BOOTP && CMD_PXE
1341 Supported for ARM, ARM64, and x86 for now.
1343 config BOOTP_PXE_CLIENTARCH
1345 depends on BOOTP_PXE
1346 default 0x16 if ARM64
1350 config BOOTP_VCI_STRING
1352 depends on CMD_BOOTP
1353 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1354 default "U-Boot.armv8" if ARM64
1355 default "U-Boot.arm" if ARM
1362 tftpboot - boot image via network using TFTP protocol
1366 depends on CMD_TFTPBOOT
1368 TFTP put command, for uploading files to a server
1372 depends on CMD_TFTPBOOT
1374 Act as a TFTP server and boot the first received file
1376 config NET_TFTP_VARS
1377 bool "Control TFTP timeout and count through environment"
1378 depends on CMD_TFTPBOOT
1381 If set, allows controlling the TFTP timeout through the
1382 environment variable tftptimeout, and the TFTP maximum
1383 timeout count through the variable tftptimeoutcountmax.
1384 If unset, timeout and maximum are hard-defined as 1 second
1385 and 10 timouts per TFTP transfer.
1390 Boot image via network using RARP/TFTP protocol
1396 Boot image via network using NFS protocol.
1401 Enable MII utility commands.
1406 Send ICMP ECHO_REQUEST to network host
1411 Perform CDP network configuration
1416 Synchronize RTC via network
1421 Lookup the IP of a hostname
1423 config CMD_LINK_LOCAL
1427 Acquire a network IP address using the link-local protocol
1434 Allow control of L2 Ethernet switch commands. These are supported
1435 by the vsc9953 Ethernet driver at present. Sub-commands allow
1436 operations such as enabling / disabling a port and
1437 viewing/maintaining the filtering database (FDB)
1443 Boot image via network using PXE protocol
1448 Wait for wake-on-lan Magic Packet
1452 menu "Misc commands"
1455 bool "Enable 'bmp' command"
1456 depends on LCD || DM_VIDEO || VIDEO
1458 This provides a way to obtain information about a BMP-format iamge
1459 and to display it. BMP (which presumably stands for BitMaP) is a
1460 file format defined by Microsoft which supports images of various
1461 depths, formats and compression methods. Headers on the file
1462 determine the formats used. This command can be used by first loading
1463 the image into RAM, then using this command to look at it or display
1466 config CMD_BOOTCOUNT
1468 depends on BOOTCOUNT_LIMIT
1470 Enable the bootcount command, which allows interrogation and
1471 reset of the bootcounter.
1474 bool "Enable board-specific commands"
1476 (deprecated: instead, please define a Kconfig option for each command)
1478 Some boards have board-specific commands which are only enabled
1479 during developemnt and need to be turned off for production. This
1480 option provides a way to control this. The commands that are enabled
1481 vary depending on the board.
1483 config CMD_BKOPS_ENABLE
1484 bool "mmc bkops enable"
1488 Enable command for setting manual background operations handshake
1489 on a eMMC device. The feature is optionally available on eMMC devices
1490 conforming to standard >= 4.41.
1492 config CMD_BLOCK_CACHE
1493 bool "blkcache - control and stats for block cache"
1494 depends on BLOCK_CACHE
1495 default y if BLOCK_CACHE
1497 Enable the blkcache command, which can be used to control the
1498 operation of the cache functions.
1499 This is most useful when fine-tuning the operation of the cache
1500 during development, but also allows the cache to be disabled when
1501 it might hurt performance (e.g. when using the ums command).
1504 bool "icache or dcache"
1506 Enable the "icache" and "dcache" commands
1508 config CMD_CONITRACE
1509 bool "conitrace - trace console input codes"
1511 Enable the 'conitrace' command which displays the codes received
1512 from the console input as hexadecimal numbers.
1515 bool "Enable clear screen command 'cls'"
1516 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1519 Enable the 'cls' command which clears the screen contents
1520 on video frame buffer.
1523 bool "efidebug - display/configure UEFI environment"
1524 depends on EFI_LOADER
1525 select EFI_DEVICE_PATH_TO_TEXT
1528 Enable the 'efidebug' command which provides a subset of UEFI
1529 shell utility with simplified functionality. It will be useful
1530 particularly for managing boot parameters as well as examining
1531 various EFI status for debugging.
1533 config CMD_EXCEPTION
1534 bool "exception - raise exception"
1535 depends on ARM || RISCV || X86
1537 Enable the 'exception' command which allows to raise an exception.
1544 Enable the 'led' command which allows for control of LEDs supported
1545 by the board. The LEDs can be listed with 'led list' and controlled
1546 with led on/off/togle/blink. Any LED drivers can be controlled with
1547 this command, e.g. led_gpio.
1553 Enable the 'date' command for getting/setting the time/date in RTC
1559 Run commands and summarize execution time.
1562 bool "gettime - read elapsed time"
1564 Enable the 'gettime' command which reads the elapsed time since
1565 U-Boot started running. This shows the time in seconds and
1566 milliseconds. See also the 'bootstage' command which provides more
1567 flexibility for boot timing.
1569 # TODO: rename to CMD_SLEEP
1574 Delay execution for some time
1577 bool "support for multiprocessor"
1579 This provides an option to brinup
1580 different processors in multiprocessor
1586 Access the system timer.
1592 This provides basic access to the U-Boot's sound support. The main
1593 feature is to play a beep.
1595 sound init - set up sound system
1596 sound play - play a sound
1602 This provides access to the QEMU firmware interface. The main
1603 feature is to allow easy loading of files passed to qemu-system
1604 via -kernel / -initrd
1606 source "cmd/mvebu/Kconfig"
1609 bool "terminal - provides a way to attach a serial terminal"
1611 Provides a 'cu'-like serial terminal command. This can be used to
1612 access other serial ports from the system console. The terminal
1613 is very simple with no special processing of characters. As with
1614 cu, you can press ~. (tilde followed by period) to exit.
1617 bool "uuid, guid - generation of unique IDs"
1620 This enables two commands:
1622 uuid - generate random Universally Unique Identifier
1623 guid - generate Globally Unique Identifier based on random UUID
1625 The two commands are very similar except for the endianness of the
1630 source "cmd/ti/Kconfig"
1632 config CMD_BOOTSTAGE
1633 bool "Enable the 'bootstage' command"
1634 depends on BOOTSTAGE
1636 Add a 'bootstage' command which supports printing a report
1637 and un/stashing of bootstage data.
1639 menu "Power commands"
1641 bool "Enable Driver Model PMIC command"
1644 This is the pmic command, based on a driver model pmic's API.
1645 Command features are unchanged:
1646 - list - list pmic devices
1647 - pmic dev <id> - show or [set] operating pmic device (NEW)
1648 - pmic dump - dump registers
1649 - pmic read address - read byte of register at address
1650 - pmic write address - write byte to register at address
1651 The only one change for this command is 'dev' subcommand.
1653 config CMD_REGULATOR
1654 bool "Enable Driver Model REGULATOR command"
1655 depends on DM_REGULATOR
1657 This command is based on driver model regulator's API.
1658 User interface features:
1659 - list - list regulator devices
1660 - regulator dev <id> - show or [set] operating regulator device
1661 - regulator info - print constraints info
1662 - regulator status - print operating status
1663 - regulator value <val] <-f> - print/[set] voltage value [uV]
1664 - regulator current <val> - print/[set] current value [uA]
1665 - regulator mode <id> - print/[set] operating mode id
1666 - regulator enable - enable the regulator output
1667 - regulator disable - disable the regulator output
1669 The '-f' (force) option can be used for set the value which exceeds
1670 the limits, which are found in device-tree and are kept in regulator's
1671 uclass platdata structure.
1675 menu "Security commands"
1677 bool "Enable the 'aes' command"
1680 This provides a means to encrypt and decrypt data using the AES
1681 (Advanced Encryption Standard). This algorithm uses a symetric key
1682 and is widely used as a streaming cipher. Different key lengths are
1683 supported by the algorithm but this command only supports 128 bits
1687 bool "Enable the 'blob' command"
1689 This is used with the Freescale secure boot mechanism.
1691 Freescale's SEC block has built-in Blob Protocol which provides
1692 a method for protecting user-defined data across system power
1693 cycles. SEC block protects data in a data structure called a Blob,
1694 which provides both confidentiality and integrity protection.
1696 Encapsulating data as a blob
1697 Each time that the Blob Protocol is used to protect data, a
1698 different randomly generated key is used to encrypt the data.
1699 This random key is itself encrypted using a key which is derived
1700 from SoC's non-volatile secret key and a 16 bit Key identifier.
1701 The resulting encrypted key along with encrypted data is called a
1702 blob. The non-volatile secure key is available for use only during
1705 During decapsulation, the reverse process is performed to get back
1709 blob enc - encapsulating data as a cryptgraphic blob
1710 blob dec - decapsulating cryptgraphic blob to get the data
1714 blob enc src dst len km
1716 Encapsulate and create blob of data $len bytes long
1717 at address $src and store the result at address $dst.
1718 $km is the 16 byte key modifier is also required for
1719 generation/use as key for cryptographic operation. Key
1720 modifier should be 16 byte long.
1722 blob dec src dst len km
1724 Decapsulate the blob of data at address $src and
1725 store result of $len byte at addr $dst.
1726 $km is the 16 byte key modifier is also required for
1727 generation/use as key for cryptographic operation. Key
1728 modifier should be 16 byte long.
1731 bool "Support 'hash' command"
1734 This provides a way to hash data in memory using various supported
1735 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1736 saved to memory or to an environment variable. It is also possible
1737 to verify a hash against data in memory.
1740 bool "Support the 'hvc' command"
1741 depends on ARM_SMCCC
1743 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1744 development and testing.
1747 bool "Support the 'smc' command"
1748 depends on ARM_SMCCC
1750 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1751 development and testing.
1757 Add -v option to verify data against a hash.
1767 bool "Enable the 'tpm' command"
1768 depends on TPM_V1 || TPM_V2
1769 select CMD_TPM_V1 if TPM_V1
1770 select CMD_TPM_V2 if TPM_V2
1772 This provides a means to talk to a TPM from the command line. A wide
1773 range of commands if provided - see 'tpm help' for details. The
1774 command requires a suitable TPM on your board and the correct driver
1780 bool "Enable the 'tpm test' command"
1783 This provides a a series of tests to confirm that the TPMv1.x is
1784 working correctly. The tests cover initialisation, non-volatile RAM,
1785 extend, global lock and checking that timing is within expectations.
1786 The tests pass correctly on Infineon TPMs but may need to be adjusted
1793 menu "Firmware commands"
1795 bool "Enable crosec command"
1799 Enable command-line access to the Chrome OS EC (Embedded
1800 Controller). This provides the 'crosec' command which has
1801 a number of sub-commands for performing EC tasks such as
1802 updating its flash, accessing a small saved context area
1803 and talking to the I2C bus behind the EC (if there is one).
1806 menu "Filesystem commands"
1808 bool "Enable the 'btrsubvol' command"
1811 This enables the 'btrsubvol' command to list subvolumes
1812 of a BTRFS filesystem. There are no special commands for
1813 listing BTRFS directories or loading BTRFS files - this
1814 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1815 when BTRFS is enabled (see FS_BTRFS).
1818 bool "Enable the 'cbfs' command"
1821 Define this to enable support for reading from a Coreboot
1822 filesystem. This is a ROM-based filesystem used for accessing files
1823 on systems that use coreboot as the first boot-loader and then load
1824 U-Boot to actually boot the Operating System. Available commands are
1825 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1828 bool "Enable the 'cramfs' command"
1829 depends on FS_CRAMFS
1831 This provides commands for dealing with CRAMFS (Compressed ROM
1832 filesystem). CRAMFS is useful when space is tight since files are
1833 compressed. Two commands are provided:
1835 cramfsls - lists files in a cramfs image
1836 cramfsload - loads a file from a cramfs image
1839 bool "ext2 command support"
1842 Enables EXT2 FS command
1845 bool "ext4 command support"
1848 Enables EXT4 FS command
1850 config CMD_EXT4_WRITE
1852 bool "ext4 write command support"
1855 Enables EXT4 FS write command
1858 bool "FAT command support"
1861 Support for the FAT fs
1863 config CMD_FS_GENERIC
1864 bool "filesystem commands"
1866 Enables filesystem commands (e.g. load, ls) that work for multiple
1870 bool "fsuuid command"
1872 Enables fsuuid command for filesystem UUID.
1875 bool "jffs2 command"
1878 Enables commands to support the JFFS2 (Journalling Flash File System
1879 version 2) filesystem. This enables fsload, ls and fsinfo which
1880 provide the ability to load files, list directories and obtain
1881 filesystem information.
1884 bool "MTD partition support"
1885 select MTD_DEVICE if (CMD_NAND || NAND)
1887 MTD partitioning tool support.
1888 It is strongly encouraged to avoid using this command
1889 anymore along with 'sf', 'nand', 'onenand'. One can still
1890 declare the partitions in the mtdparts environment variable
1891 but better use the MTD stack and the 'mtd' command instead.
1893 config MTDIDS_DEFAULT
1894 string "Default MTD IDs"
1895 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1897 Defines a default MTD IDs list for use with MTD partitions in the
1898 Linux MTD command line partitions format.
1900 config MTDPARTS_DEFAULT
1901 string "Default MTD partition scheme"
1902 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1904 Defines a default MTD partitioning scheme in the Linux MTD command
1905 line partitions format
1907 config CMD_MTDPARTS_SPREAD
1908 bool "Padd partition size to take account of bad blocks"
1909 depends on CMD_MTDPARTS
1911 This enables the 'spread' sub-command of the mtdparts command.
1912 This command will modify the existing mtdparts variable by increasing
1913 the size of the partitions such that 1) each partition's net size is
1914 at least as large as the size specified in the mtdparts variable and
1915 2) each partition starts on a good block.
1918 bool "reiser - Access to reiserfs filesystems"
1920 This provides two commands which operate on a resierfs filesystem,
1921 commonly used some years ago:
1923 reiserls - list files
1924 reiserload - load a file
1927 bool "yaffs2 - Access of YAFFS2 filesystem"
1931 This provides commands for accessing a YAFFS2 filesystem. Yet
1932 Another Flash Filesystem 2 is a filesystem designed specifically
1933 for NAND flash. It incorporates bad-block management and ensures
1934 that device writes are sequential regardless of filesystem
1938 bool "zfs - Access of ZFS filesystem"
1940 This provides commands to accessing a ZFS filesystem, commonly used
1941 on Solaris systems. Two sub-commands are provided:
1943 zfsls - list files in a directory
1944 zfsload - load a file
1946 See doc/README.zfs for more details.
1950 menu "Debug commands"
1955 The bedbug (emBEDded deBUGger) command provides debugging features
1956 for some PowerPC processors. For details please see the
1957 docuemntation in doc/README.beddbug
1960 bool "diag - Board diagnostics"
1962 This command provides access to board diagnostic tests. These are
1963 called Power-on Self Tests (POST). The command allows listing of
1964 available tests and running either all the tests, or specific tests
1968 bool "irq - Show information about interrupts"
1969 depends on !ARM && !MIPS && !SH
1971 This enables two commands:
1973 interrupts - enable or disable interrupts
1974 irqinfo - print device-specific interrupt information
1977 bool "kgdb - Allow debugging of U-Boot with gdb"
1980 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1981 over a serial link for debugging purposes. This allows
1982 single-stepping, inspecting variables, etc. This is supported only
1983 on PowerPC at present.
1986 bool "log - Generation, control and access to logging"
1989 This provides access to logging features. It allows the output of
1990 log data to be controlled to a limited extent (setting up the default
1991 maximum log level for emitting of records). It also provides access
1992 to a command used for testing the log system.
1995 bool "trace - Support tracing of function calls and timing"
1997 Enables a command to control using of function tracing within
1998 U-Boot. This allows recording of call traces including timing
1999 information. The command can write data to memory for exporting
2000 for analysis (e.g. using bootchart). See doc/README.trace for full
2004 bool "avb - Android Verified Boot 2.0 operations"
2005 depends on AVB_VERIFY
2008 Enables a "avb" command to perform verification of partitions using
2009 Android Verified Boot 2.0 functionality. It includes such subcommands:
2010 avb init - initialize avb2 subsystem
2011 avb read_rb - read rollback index
2012 avb write_rb - write rollback index
2013 avb is_unlocked - check device lock state
2014 avb get_uuid - read and print uuid of a partition
2015 avb read_part - read data from partition
2016 avb read_part_hex - read data from partition and output to stdout
2017 avb write_part - write data to partition
2018 avb verify - run full verification chain
2022 tristate "Enable UBI - Unsorted block images commands"
2025 UBI is a software layer above MTD layer which admits use of LVM-like
2026 logical volumes on top of MTD devices, hides some complexities of
2027 flash chips like wear and bad blocks and provides some other useful
2028 capabilities. Please, consult the MTD web site for more details
2029 (www.linux-mtd.infradead.org). Activate this option if you want
2030 to use U-Boot UBI commands.
2031 It is also strongly encouraged to also enable CONFIG_MTD to get full
2035 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2037 default y if CMD_UBI
2040 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob