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.
51 default "Zynq> " if ARCH_ZYNQ
52 default "ZynqMP> " if ARCH_ZYNQMP
55 This string is displayed in the command line to the left of the
59 string "Command execution tracer"
63 This option enables the possiblity to print all commands before
64 executing them and after all variables are evaluated (similar
65 to Bash's xtrace/'set -x' feature).
66 To enable the tracer a variable "xtrace" needs to be defined in
69 menu "Autoboot options"
75 This enables the autoboot. See doc/README.autoboot for detail.
78 bool "Stop autobooting via specific input key / string"
81 This option enables stopping (aborting) of the automatic
82 boot feature only by issuing a specific input key or
83 string. If not enabled, any input key will abort the
84 U-Boot automatic booting process and bring the device
85 to the U-Boot prompt for user input.
87 config AUTOBOOT_PROMPT
88 string "Autoboot stop prompt"
89 depends on AUTOBOOT_KEYED
90 default "Autoboot in %d seconds\\n"
92 This string is displayed before the boot delay selected by
93 CONFIG_BOOTDELAY starts. If it is not defined there is no
94 output indicating that autoboot is in progress.
96 Note that this define is used as the (only) argument to a
97 printf() call, so it may contain '%' format specifications,
98 provided that it also includes, sepearated by commas exactly
99 like in a printf statement, the required arguments. It is
100 the responsibility of the user to select only such arguments
101 that are valid in the given context.
103 config AUTOBOOT_ENCRYPTION
104 bool "Enable encryption in autoboot stopping"
105 depends on AUTOBOOT_KEYED
107 This option allows a string to be entered into U-Boot to stop the
108 autoboot. The string itself is hashed and compared against the hash
109 in the environment variable 'bootstopkeysha256'. If it matches then
110 boot stops and a command-line prompt is presented.
112 This provides a way to ship a secure production device which can also
113 be accessed at the U-Boot command line.
115 config AUTOBOOT_DELAY_STR
116 string "Delay autobooting via specific input key / string"
117 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
119 This option delays the automatic boot feature by issuing
120 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
121 or the environment variable "bootdelaykey" is specified
122 and this string is received from console input before
123 autoboot starts booting, U-Boot gives a command prompt. The
124 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
125 used, otherwise it never times out.
127 config AUTOBOOT_STOP_STR
128 string "Stop autobooting via specific input key / string"
129 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
131 This option enables stopping (aborting) of the automatic
132 boot feature only by issuing a specific input key or
133 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
134 variable "bootstopkey" is specified and this string is
135 received from console input before autoboot starts booting,
136 U-Boot gives a command prompt. The U-Boot prompt never
137 times out, even if CONFIG_BOOT_RETRY_TIME is used.
139 config AUTOBOOT_KEYED_CTRLC
140 bool "Enable Ctrl-C autoboot interruption"
141 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
144 This option allows for the boot sequence to be interrupted
145 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
146 Setting this variable provides an escape sequence from the
147 limited "password" strings.
149 config AUTOBOOT_STOP_STR_SHA256
150 string "Stop autobooting via SHA256 encrypted password"
151 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
153 This option adds the feature to only stop the autobooting,
154 and therefore boot into the U-Boot prompt, when the input
155 string / password matches a values that is encypted via
156 a SHA256 hash and saved in the environment.
158 config AUTOBOOT_USE_MENUKEY
159 bool "Allow a specify key to run a menu from the environment"
160 depends on !AUTOBOOT_KEYED
162 If a specific key is pressed to stop autoboot, then the commands in
163 the environment variable 'menucmd' are executed before boot starts.
165 config AUTOBOOT_MENUKEY
166 int "ASCII value of boot key to show a menu"
168 depends on AUTOBOOT_USE_MENUKEY
170 If this key is pressed to stop autoboot, then the commands in the
171 environment variable 'menucmd' will be executed before boot starts.
172 For example, 33 means "!" in ASCII, so pressing ! at boot would take
175 config AUTOBOOT_MENU_SHOW
176 bool "Show a menu on boot"
177 depends on CMD_BOOTMENU
179 This enables the boot menu, controlled by environment variables
180 defined by the board. The menu starts after running the 'preboot'
181 environmnent variable (if enabled) and before handling the boot delay.
182 See README.bootmenu for more details.
204 Print ".config" contents.
206 If this option is enabled, the ".config" file contents are embedded
207 in the U-Boot image and can be printed on the console by the "config"
208 command. This provides information of which options are enabled on
215 Print console devices and information.
220 Print information about available CPUs. This normally shows the
221 number of CPUs, type (e.g. manufacturer, architecture, product or
222 internal name) and clock frequency. Other information may be
223 available depending on the CPU driver.
229 Print GPL license text
245 Run the command stored in the environment "bootcmd", i.e.
246 "bootd" does the same thing as "run bootcmd".
252 Boot an application image from the memory.
257 Boot the Linux zImage
261 depends on ARM64 || RISCV
264 Boot an AArch64 Linux Kernel image from memory.
268 depends on EFI_LOADER
271 Boot an EFI image from memory.
274 bool "Support booting Linux OS images"
275 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
278 Support booting the Linux kernel directly via a command such as bootm
282 bool "Support booting NetBSD (non-EFI) loader images"
286 Support booting NetBSD via the bootm command.
288 config BOOTM_OPENRTOS
289 bool "Support booting OPENRTOS / FreeRTOS images"
292 Support booting OPENRTOS / FreeRTOS via the bootm command.
295 bool "Support booting Enea OSE images"
298 Support booting Enea OSE images via the bootm command.
301 bool "Support booting Plan9 OS images"
305 Support booting Plan9 images via the bootm command.
308 bool "Support booting RTEMS OS images"
312 Support booting RTEMS images via the bootm command.
315 bool "Support booting VxWorks OS images"
319 Support booting VxWorks images via the bootm command.
321 config CMD_BOOTEFI_HELLO_COMPILE
322 bool "Compile a standard EFI hello world binary for testing"
323 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
326 This compiles a standard EFI hello world application with U-Boot so
327 that it can be used with the test/py testing framework. This is useful
328 for testing that EFI is working at a basic level, and for bringing
329 up EFI support on a new architecture.
331 No additional space will be required in the resulting U-Boot binary
332 when this option is enabled.
334 config CMD_BOOTEFI_HELLO
335 bool "Allow booting a standard EFI hello world for testing"
336 depends on CMD_BOOTEFI_HELLO_COMPILE
338 This adds a standard EFI hello world application to U-Boot so that
339 it can be used with the 'bootefi hello' command. This is useful
340 for testing that EFI is working at a basic level, and for bringing
341 up EFI support on a new architecture.
343 source lib/efi_selftest/Kconfig
349 Add an ANSI terminal boot menu command.
354 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
355 image into RAM, dump image structure information, etc. Those dtb/dtbo
356 files should be merged in one dtb further, which needs to be passed to
357 the kernel, as part of a boot process.
360 bool "bootelf, bootvx"
363 Boot an ELF/vxWorks image from the memory.
366 bool "Flattened Device Tree utility commands"
370 Do FDT related setup before booting into the Operating System.
376 Start an application at a given address.
382 Run the command in the given environment variable.
388 Print header information for application image.
393 List all images found in flash
399 Extract a part of a multi-image.
402 bool "spl export - Export boot information for Falcon boot"
405 Falcon mode allows booting directly from SPL into an Operating
406 System such as Linux, thus skipping U-Boot proper. See
407 doc/README.falcon for full information about how to use this
410 config CMD_SPL_NAND_OFS
411 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
412 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
415 This provides the offset of the command line arguments for Linux
416 when booting from NAND in Falcon mode. See doc/README.falcon
417 for full information about how to use this option (and also see
418 board/gateworks/gw_ventana/README for an example).
420 config CMD_SPL_NOR_OFS
421 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
422 depends on CMD_SPL && SPL_NOR_SUPPORT
425 This provides the offset of the command line arguments or dtb for
426 Linux when booting from NOR in Falcon mode.
428 config CMD_SPL_WRITE_SIZE
429 hex "Size of argument area"
433 This provides the size of the command-line argument area in NAND
434 flash used by Falcon-mode boot. See the documentation until CMD_SPL
438 bool "fitImage update command"
440 Implements the 'fitupd' command, which allows to automatically
441 store software updates present on a TFTP server in NOR Flash
443 config CMD_THOR_DOWNLOAD
444 bool "thor - TIZEN 'thor' download"
446 Implements the 'thor' download protocol. This is a way of
447 downloading a software update over USB from an attached host.
448 There is no documentation about this within the U-Boot source code
449 but you should be able to find something on the interwebs.
452 bool "zboot - x86 boot command"
454 With x86 machines it is common to boot a bzImage file which
455 contains both a kernel and a setup.bin file. The latter includes
456 configuration information from the dark ages which x86 boards still
457 need to pick things out of.
459 Consider using FIT in preference to this since it supports directly
460 booting both 32- and 64-bit kernels, as well as secure boot.
461 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
465 menu "Environment commands"
468 bool "ask for env variable"
470 Ask for environment variable
488 Edit environment variable.
493 Allow for searching environment variables
499 Save all environment variables into the compiled-in persistent
505 depends on CMD_SAVEENV
507 Erase environment variables from the compiled-in persistent
510 config CMD_ENV_EXISTS
514 Check if a variable is defined in the environment for use in
517 config CMD_ENV_CALLBACK
518 bool "env callbacks - print callbacks and their associated variables"
520 Some environment variable have callbacks defined by
521 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
522 For example changing "baudrate" adjust the serial baud rate. This
523 command lists the currently defined callbacks.
526 bool "env flags -print variables that have non-default flags"
528 Some environment variables have special flags that control their
529 behaviour. For example, serial# can only be written once and cannot
530 be deleted. This command shows the variables that have special
533 config CMD_NVEDIT_EFI
534 bool "env [set|print] -e - set/print UEFI variables"
535 depends on EFI_LOADER
538 UEFI variables are encoded as some form of U-Boot variables.
539 If enabled, we are allowed to set/print UEFI variables using
540 "env" command with "-e" option without knowing details.
542 config CMD_NVEDIT_INFO
543 bool "env info - print or evaluate environment information"
545 Print environment information:
546 - env_valid : is environment valid
547 - env_ready : is environment imported into hash table
548 - env_use_default : is default environment used
550 This command can be optionally used for evaluation in scripts:
551 [-d] : evaluate whether default environment is used
552 [-p] : evaluate whether environment can be persisted
553 The result of multiple evaluations will be combined with AND.
557 menu "Memory commands"
562 Compute binary operations (xor, or, and) of byte arrays of arbitrary
563 size from memory and store the result in memory or the environment.
576 Add -v option to verify data against a crc32 checksum.
579 bool "eeprom - EEPROM subsystem"
581 (deprecated, needs conversion to driver model)
582 Provides commands to read and write EEPROM (Electrically Erasable
583 Programmable Read Only Memory) chips that are connected over an
586 config CMD_EEPROM_LAYOUT
587 bool "Enable layout-aware eeprom commands"
588 depends on CMD_EEPROM
590 (deprecated, needs conversion to driver model)
591 When enabled, additional eeprom sub-commands become available.
593 eeprom print - prints the contents of the eeprom in a human-readable
594 way (eeprom layout fields, and data formatted to be fit for human
597 eeprom update - allows user to update eeprom fields by specifying
598 the field name, and providing the new data in a human readable format
599 (same format as displayed by the eeprom print command).
601 Both commands can either auto detect the layout, or be told which
605 __weak int parse_layout_version(char *str)
606 - override to provide your own layout name parsing
607 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
609 - override to setup the layout metadata based on the version
610 __weak int eeprom_layout_detect(unsigned char *data)
611 - override to provide your own algorithm for detecting layout
614 - contains various printing and updating functions for common
615 types of eeprom fields. Can be used for defining
618 config EEPROM_LAYOUT_HELP_STRING
619 string "Tells user what layout names are supported"
620 depends on CMD_EEPROM_LAYOUT
621 default "<not defined>"
623 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
629 Infinite write loop on address range
636 Compute MD5 checksum.
641 depends on CMD_MD5SUM
643 Add -v option to verify data against an MD5 checksum.
648 Display memory information.
651 bool "md, mm, nm, mw, cp, cmp, base, loop"
656 mm - memory modify (auto-incrementing address)
657 nm - memory modify (constant address)
658 mw - memory write (fill)
661 base - print or set address offset
662 loop - initialize loop on address range
665 bool "Enable cyclic md/mw commands"
666 depends on CMD_MEMORY
668 Add the "mdc" and "mwc" memory commands. These are cyclic
673 This command will print 4 bytes (10,11,12,13) each 500 ms.
675 => mwc.l 100 12345678 10
676 This command will write 12345678 to address 100 all 10 ms.
681 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
683 random - fill memory with random data
688 Simple RAM read/write test.
692 config SYS_ALT_MEMTEST
693 bool "Alternative test"
695 Use a more complete alternative memory test.
702 mdc - memory display cyclic
703 mwc - memory write cyclic
709 Compute SHA1 checksum.
711 config SHA1SUM_VERIFY
713 depends on CMD_SHA1SUM
715 Add -v option to verify data against a SHA1 checksum.
718 bool "strings - display strings in memory"
720 This works similarly to the Unix 'strings' command except that it
721 works with a memory range. String of printable characters found
722 within the range are displayed. The minimum number of characters
723 for a sequence to be considered a string can be provided.
727 menu "Compression commands"
731 default y if CMD_BOOTI
734 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
739 default y if CMD_BOOTI
741 Uncompress a zip-compressed memory region.
746 Compress a memory region with zlib deflate method.
750 menu "Device access commands"
753 #depends on FLASH_CFI_DRIVER
756 ARM Ltd reference designs flash partition access
759 bool "adc - Access Analog to Digital Converters info and data"
763 Shows ADC device info and permit printing one-shot analog converted
764 data from a named Analog to Digital Converter.
769 depends on PARTITIONS
771 Read/modify/write the fields of Bootloader Control Block, usually
772 stored on the flash "misc" partition with its structure defined in:
773 https://android.googlesource.com/platform/bootable/recovery/+/master/
774 bootloader_message/include/bootloader_message/bootloader_message.h
776 Some real-life use-cases include (but are not limited to):
777 - Determine the "boot reason" (and act accordingly):
778 https://source.android.com/devices/bootloader/boot-reason
779 - Get/pass a list of commands from/to recovery:
780 https://android.googlesource.com/platform/bootable/recovery
781 - Inspect/dump the contents of the BCB fields
784 bool "bind/unbind - Bind or unbind a device to/from a driver"
787 Bind or unbind a device to/from a driver from the command line.
788 This is useful in situations where a device may be handled by several
789 drivers. For example, this can be used to bind a UDC to the usb ether
790 gadget driver from the command line.
793 bool "clk - Show clock frequencies"
796 Shows clock frequences by calling a sock_clk_dump() hook function.
797 This is depreated in favour of using the CLK uclass and accessing
798 clock values from associated drivers. However currently no command
802 bool "demo - Demonstration commands for driver model"
805 Provides a 'demo' command which can be used to play around with
806 driver model. To use this properly you will need to enable one or
807 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
808 Otherwise you will always get an empty list of devices. The demo
809 devices are defined in the sandbox device tree, so the easiest
810 option is to use sandbox and pass the -d point to sandbox's
817 Enables the command "dfu" which is used to have U-Boot create a DFU
818 class device via USB. This command requires that the "dfu_alt_info"
819 environment variable be set and define the alt settings to expose to
823 bool "dm - Access to driver model information"
826 Provides access to driver model data structures and information,
827 such as a list of devices, list of uclasses and the state of each
828 device (e.g. activated). This is not required for operation, but
829 can be useful to see the state of driver model for debugging or
833 bool "fastboot - Android fastboot support"
836 This enables the command "fastboot" which enables the Android
837 fastboot mode for the platform. Fastboot is a protocol for
838 downloading images, flashing and device control used on
839 Android devices. Fastboot requires either the network stack
840 enabled or support for acting as a USB device.
842 See doc/android/fastboot.txt for more information.
845 bool "fdcboot - Boot from floppy device"
847 The 'fdtboot' command allows booting an image from a floppy disk.
850 bool "flinfo, erase, protect"
854 flinfo - print FLASH memory information
856 protect - enable or disable FLASH write protection
865 config CMD_FPGA_LOADBP
866 bool "fpga loadbp - load partial bitstream (Xilinx only)"
869 Supports loading an FPGA device from a bitstream buffer containing
872 config CMD_FPGA_LOADFS
873 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
876 Supports loading an FPGA device from a FAT filesystem.
878 config CMD_FPGA_LOADMK
879 bool "fpga loadmk - load bitstream from image"
882 Supports loading an FPGA device from a image generated by mkimage.
884 config CMD_FPGA_LOADP
885 bool "fpga loadp - load partial bitstream"
888 Supports loading an FPGA device from a bitstream buffer containing
891 config CMD_FPGA_LOAD_SECURE
892 bool "fpga loads - loads secure bitstreams (Xilinx only)"
895 Enables the fpga loads command which is used to load secure
896 (authenticated or encrypted or both) bitstreams on to FPGA.
899 bool "fpgad - dump FPGA registers"
901 (legacy, needs conversion to driver model)
902 Provides a way to dump FPGA registers by calling the board-specific
903 fpga_get_reg() function. This functions similarly to the 'md'
907 bool "fuse - support for the fuse subssystem"
909 (deprecated - needs conversion to driver model)
910 This allows reading, sensing, programming or overriding fuses
911 which control the behaviour of the device. The command uses the
920 bool "GPT (GUID Partition Table) command"
922 select HAVE_BLOCK_DEVICE
923 select PARTITION_UUIDS
926 Enable the 'gpt' command to ready and write GPT style partition
930 bool "GPT Random UUID generation"
933 Enable the generation of partitions with random UUIDs if none
936 config CMD_GPT_RENAME
937 bool "GPT partition renaming commands"
940 Enables the 'gpt' command to interchange names on two GPT
941 partitions via the 'gpt swap' command or to rename single
942 partitions via the 'rename' command.
945 bool "ide - Support for IDE drivers"
948 Provides an 'ide' command which allows accessing the IDE drive,
949 reseting the IDE interface, printing the partition table and
950 geting device info. It also enables the 'diskboot' command which
951 permits booting from an IDE drive.
954 bool "io - Support for performing I/O accesses"
956 Provides an 'iod' command to display I/O space and an 'iow' command
957 to write values to the I/O space. This can be useful for manually
958 checking the state of devices during boot when debugging device
962 bool "iotrace - Support for tracing I/O activity"
964 Provides an 'iotrace' command which supports recording I/O reads and
965 writes in a trace buffer in memory . It also maintains a checksum
966 of the trace records (even if space is exhausted) so that the
967 sequence of I/O accesses can be verified.
969 When debugging drivers it is useful to see what I/O accesses were
970 done and in what order.
972 Even if the individual accesses are of little interest it can be
973 useful to verify that the access pattern is consistent each time
974 an operation is performed. In this case a checksum can be used to
975 characterise the operation of a driver. The checksum can be compared
976 across different runs of the operation to verify that the driver is
979 In particular, when performing major refactoring of the driver, where
980 the access pattern should not change, the checksum provides assurance
981 that the refactoring work has not broken the driver.
983 This works by sneaking into the io.h heder for an architecture and
984 redirecting I/O accesses through iotrace's tracing mechanism.
986 For now no commands are provided to examine the trace buffer. The
987 format is fairly simple, so 'md' is a reasonable substitute.
989 Note: The checksum feature is only useful for I/O regions where the
990 contents do not change outside of software control. Where this is not
991 suitable you can fall back to manually comparing the addresses. It
992 might be useful to enhance tracing to only checksum the accesses and
993 not the data read/written.
1003 bool "w1 - Support for Dallas 1-Wire protocol"
1005 Dallas 1-wire protocol support
1011 Load a binary file over serial line.
1017 Load an S-Record file over serial line
1022 MMC memory mapped support.
1025 bool "Enable support for RPMB in the mmc command"
1028 Enable the commands for reading, writing and programming the
1029 key for the Replay Protection Memory Block partition in eMMC.
1031 config CMD_MMC_SWRITE
1033 depends on CMD_MMC && MMC_WRITE
1036 Enable support for the "mmc swrite" command to write Android sparse
1041 select MTD_PARTITIONS
1043 MTD commands support.
1047 default y if NAND_SUNXI
1052 config CMD_NAND_TRIMFFS
1053 bool "nand write.trimffs"
1054 default y if ARCH_SUNXI
1056 Allows one to skip empty pages when flashing something on a NAND.
1058 config CMD_NAND_LOCK_UNLOCK
1059 bool "nand lock/unlock"
1061 NAND locking support.
1063 config CMD_NAND_TORTURE
1066 NAND torture support.
1075 NVM Express device support
1078 bool "onenand - access to onenand device"
1080 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1081 various useful features. This command allows reading, writing,
1082 and erasing blocks. It allso provides a way to show and change
1083 bad blocks, and test the device.
1088 Enable the 'osd' command which allows to query information from and
1089 write text data to a on-screen display (OSD) device; a virtual device
1090 associated with a display capable of displaying a text overlay on the
1091 display it's associated with..
1095 select HAVE_BLOCK_DEVICE
1096 select PARTITION_UUIDS
1098 Read and display information about the partition table on
1102 bool "pci - Access PCI devices"
1104 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1105 used on some devices to allow the CPU to communicate with its
1106 peripherals. Sub-commands allow bus enumeration, displaying and
1107 changing configuration space and a few other features.
1110 bool "pinmux - show pins muxing"
1111 default y if PINCTRL
1113 Parse all available pin-controllers and show pins muxing. This
1114 is useful for debug purpoer to check the pin muxing and to know if
1115 a pin is configured as a GPIO or as an alternate function.
1120 Poweroff/Shutdown the system
1123 bool "read - Read binary data from a partition"
1125 Provides low-level access to the data in a partition.
1127 config CMD_REMOTEPROC
1129 depends on REMOTEPROC
1131 Support for Remote Processor control
1134 bool "sata - Access SATA subsystem"
1137 SATA (Serial Advanced Technology Attachment) is a serial bus
1138 standard for connecting to hard drives and other storage devices.
1139 This command provides information about attached devices and allows
1140 reading, writing and other operations.
1142 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1143 Attachment, where AT refers to an IBM AT (Advanced Technology)
1144 computer released in 1984.
1147 bool "saves - Save a file over serial in S-Record format"
1149 Provides a way to save a binary file using the Motorola S-Record
1150 format over the serial line.
1153 bool "scsi - Access to SCSI devices"
1156 This provides a 'scsi' command which provides access to SCSI (Small
1157 Computer System Interface) devices. The command provides a way to
1158 scan the bus, reset the bus, read and write data and get information
1162 bool "sdram - Print SDRAM configuration information"
1164 Provides information about attached SDRAM. This assumed that the
1165 SDRAM has an EEPROM with information that can be read using the
1166 I2C bus. This is only available on some boards.
1170 depends on DM_SPI_FLASH || SPI_FLASH
1171 default y if DM_SPI_FLASH
1176 bool "sf test - Allow testing of SPI flash"
1179 Provides a way to test that SPI flash is working correctly. The
1180 test is destructive, in that an area of SPI flash must be provided
1181 for the test to use. Performance information is also provided,
1182 measuring the performance of reading, writing and erasing in
1183 Mbps (Million Bits Per Second). This value should approximately
1184 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1185 everything is working properly.
1188 bool "sspi - Command to access spi device"
1191 SPI utility command.
1193 config DEFAULT_SPI_BUS
1194 int "default spi bus used by sspi command"
1198 config DEFAULT_SPI_MODE
1199 hex "default spi mode used by sspi command (see include/spi.h)"
1204 bool "tsi148 - Command to access tsi148 device"
1206 This provides various sub-commands to initialise and configure the
1207 Turndra tsi148 device. See the command help for full details.
1210 bool "Enable UFS - Universal Flash Subsystem commands"
1213 "This provides commands to initialise and configure universal flash
1217 bool "universe - Command to set up the Turndra Universe controller"
1219 This allows setting up the VMEbus provided by this controller.
1220 See the command help for full details.
1224 select HAVE_BLOCK_DEVICE
1230 select USB_FUNCTION_SDP
1232 Enables the command "sdp" which is used to have U-Boot emulating the
1233 Serial Download Protocol (SDP) via USB.
1237 depends on USB_FUNCTION_ROCKUSB
1239 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1240 read/write info, image to/from devices. This enable rockusb command
1241 support to communication with rockusb device. for more detail about
1242 this command, please read doc/README.rockusb.
1244 config CMD_USB_MASS_STORAGE
1245 bool "UMS usb mass storage"
1246 select USB_FUNCTION_MASS_STORAGE
1248 USB mass storage support
1255 VirtIO block device support
1261 This provides commands to control the watchdog timer devices.
1267 Enable the command "axi" for accessing AXI (Advanced eXtensible
1268 Interface) busses, a on-chip interconnect specification for managing
1269 functional blocks in SoC designs, which is also often used in designs
1270 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1274 menu "Shell scripting commands"
1280 Echo args to console
1286 Return true/false on integer compare.
1292 Run script from memory
1298 Evaluate boolean and math expressions and store the result in an env
1300 Also supports loading the value at a memory location into a variable.
1301 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1305 menu "Android support commands"
1307 config CMD_AB_SELECT
1310 depends on ANDROID_AB
1312 On Android devices with more than one boot slot (multiple copies of
1313 the kernel and system images) this provides a command to select which
1314 slot should be used to boot from and register the boot attempt. This
1315 is used by the new A/B update model where one slot is updated in the
1316 background while running from the other slot.
1323 bool "Network commands"
1333 bootp - boot image via network using BOOTP/TFTP protocol
1337 depends on CMD_BOOTP
1339 Boot image via network using DHCP/TFTP protocol
1341 config BOOTP_BOOTPATH
1342 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1344 depends on CMD_BOOTP
1346 Even though the config is called BOOTP_BOOTPATH, it stores the
1347 path in the variable 'rootpath'.
1350 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1352 depends on CMD_BOOTP
1354 The primary DNS server is stored as 'dnsip'. If two servers are
1355 returned, you must set BOOTP_DNS2 to store that second server IP
1359 bool "Store 'dnsip2' from BOOTP/DHCP server"
1360 depends on BOOTP_DNS
1362 If a DHCP client requests the DNS server IP from a DHCP server,
1363 it is possible that more than one DNS serverip is offered to the
1364 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1365 server IP will be stored in the additional environment
1366 variable "dnsip2". The first DNS serverip is always
1367 stored in the variable "dnsip", when BOOTP_DNS is defined.
1369 config BOOTP_GATEWAY
1370 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1372 depends on CMD_BOOTP
1374 config BOOTP_HOSTNAME
1375 bool "Request & store 'hostname' from BOOTP/DHCP server"
1377 depends on CMD_BOOTP
1379 The name may or may not be qualified with the local domain name.
1381 config BOOTP_PREFER_SERVERIP
1382 bool "serverip variable takes precedent over DHCP server IP."
1383 depends on CMD_BOOTP
1385 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1387 With this option enabled, the 'serverip' variable in the environment
1388 takes precedence over DHCP server IP and will only be set by the DHCP
1389 server if not already set in the environment.
1391 config BOOTP_SUBNETMASK
1392 bool "Request & store 'netmask' from BOOTP/DHCP server"
1394 depends on CMD_BOOTP
1396 config BOOTP_NTPSERVER
1397 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1398 depends on CMD_BOOTP
1403 Selecting this will allow capturing all Ethernet packets and store
1404 them in physical memory in a PCAP formated file,
1405 later to be analyzed by PCAP reader application (IE. WireShark).
1408 bool "Send PXE client arch to BOOTP/DHCP server"
1410 depends on CMD_BOOTP && CMD_PXE
1412 Supported for ARM, ARM64, and x86 for now.
1414 config BOOTP_PXE_CLIENTARCH
1416 depends on BOOTP_PXE
1417 default 0x16 if ARM64
1421 config BOOTP_VCI_STRING
1423 depends on CMD_BOOTP
1424 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1425 default "U-Boot.armv8" if ARM64
1426 default "U-Boot.arm" if ARM
1433 tftpboot - boot image via network using TFTP protocol
1437 depends on CMD_TFTPBOOT
1439 TFTP put command, for uploading files to a server
1443 depends on CMD_TFTPBOOT
1445 Act as a TFTP server and boot the first received file
1447 config NET_TFTP_VARS
1448 bool "Control TFTP timeout and count through environment"
1449 depends on CMD_TFTPBOOT
1452 If set, allows controlling the TFTP timeout through the
1453 environment variable tftptimeout, and the TFTP maximum
1454 timeout count through the variable tftptimeoutcountmax.
1455 If unset, timeout and maximum are hard-defined as 1 second
1456 and 10 timouts per TFTP transfer.
1461 Boot image via network using RARP/TFTP protocol
1467 Boot image via network using NFS protocol.
1472 Enable MII utility commands.
1477 Send ICMP ECHO_REQUEST to network host
1482 Perform CDP network configuration
1487 Synchronize RTC via network
1492 Lookup the IP of a hostname
1494 config CMD_LINK_LOCAL
1498 Acquire a network IP address using the link-local protocol
1505 Allow control of L2 Ethernet switch commands. These are supported
1506 by the vsc9953 Ethernet driver at present. Sub-commands allow
1507 operations such as enabling / disabling a port and
1508 viewing/maintaining the filtering database (FDB)
1514 Boot image via network using PXE protocol
1519 Wait for wake-on-lan Magic Packet
1523 menu "Misc commands"
1526 bool "Enable 'bmp' command"
1527 depends on LCD || DM_VIDEO || VIDEO
1529 This provides a way to obtain information about a BMP-format image
1530 and to display it. BMP (which presumably stands for BitMaP) is a
1531 file format defined by Microsoft which supports images of various
1532 depths, formats and compression methods. Headers on the file
1533 determine the formats used. This command can be used by first loading
1534 the image into RAM, then using this command to look at it or display
1537 config CMD_BOOTCOUNT
1539 depends on BOOTCOUNT_LIMIT
1541 Enable the bootcount command, which allows interrogation and
1542 reset of the bootcounter.
1545 bool "Enable board-specific commands"
1547 (deprecated: instead, please define a Kconfig option for each command)
1549 Some boards have board-specific commands which are only enabled
1550 during developemnt and need to be turned off for production. This
1551 option provides a way to control this. The commands that are enabled
1552 vary depending on the board.
1554 config CMD_BKOPS_ENABLE
1555 bool "mmc bkops enable"
1559 Enable command for setting manual background operations handshake
1560 on a eMMC device. The feature is optionally available on eMMC devices
1561 conforming to standard >= 4.41.
1563 config CMD_BLOCK_CACHE
1564 bool "blkcache - control and stats for block cache"
1565 depends on BLOCK_CACHE
1566 default y if BLOCK_CACHE
1568 Enable the blkcache command, which can be used to control the
1569 operation of the cache functions.
1570 This is most useful when fine-tuning the operation of the cache
1571 during development, but also allows the cache to be disabled when
1572 it might hurt performance (e.g. when using the ums command).
1575 bool "icache or dcache"
1577 Enable the "icache" and "dcache" commands
1579 config CMD_CONITRACE
1580 bool "conitrace - trace console input codes"
1582 Enable the 'conitrace' command which displays the codes received
1583 from the console input as hexadecimal numbers.
1586 bool "Enable clear screen command 'cls'"
1587 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1590 Enable the 'cls' command which clears the screen contents
1591 on video frame buffer.
1594 bool "efidebug - display/configure UEFI environment"
1595 depends on EFI_LOADER
1596 select EFI_DEVICE_PATH_TO_TEXT
1599 Enable the 'efidebug' command which provides a subset of UEFI
1600 shell utility with simplified functionality. It will be useful
1601 particularly for managing boot parameters as well as examining
1602 various EFI status for debugging.
1604 config CMD_EXCEPTION
1605 bool "exception - raise exception"
1606 depends on ARM || RISCV || X86
1608 Enable the 'exception' command which allows to raise an exception.
1615 Enable the 'led' command which allows for control of LEDs supported
1616 by the board. The LEDs can be listed with 'led list' and controlled
1617 with led on/off/togle/blink. Any LED drivers can be controlled with
1618 this command, e.g. led_gpio.
1624 Enable the 'date' command for getting/setting the time/date in RTC
1630 Run commands and summarize execution time.
1633 bool "gettime - read elapsed time"
1635 Enable the 'gettime' command which reads the elapsed time since
1636 U-Boot started running. This shows the time in seconds and
1637 milliseconds. See also the 'bootstage' command which provides more
1638 flexibility for boot timing.
1640 # TODO: rename to CMD_SLEEP
1645 Delay execution for some time
1648 bool "support for multiprocessor"
1650 This provides an option to brinup
1651 different processors in multiprocessor
1657 Access the system timer.
1663 This provides basic access to the U-Boot's sound support. The main
1664 feature is to play a beep.
1666 sound init - set up sound system
1667 sound play - play a sound
1673 This provides access to the QEMU firmware interface. The main
1674 feature is to allow easy loading of files passed to qemu-system
1675 via -kernel / -initrd
1677 source "cmd/mvebu/Kconfig"
1680 bool "terminal - provides a way to attach a serial terminal"
1682 Provides a 'cu'-like serial terminal command. This can be used to
1683 access other serial ports from the system console. The terminal
1684 is very simple with no special processing of characters. As with
1685 cu, you can press ~. (tilde followed by period) to exit.
1688 bool "uuid, guid - generation of unique IDs"
1691 This enables two commands:
1693 uuid - generate random Universally Unique Identifier
1694 guid - generate Globally Unique Identifier based on random UUID
1696 The two commands are very similar except for the endianness of the
1701 source "cmd/ti/Kconfig"
1703 config CMD_BOOTSTAGE
1704 bool "Enable the 'bootstage' command"
1705 depends on BOOTSTAGE
1707 Add a 'bootstage' command which supports printing a report
1708 and un/stashing of bootstage data.
1710 menu "Power commands"
1712 bool "Enable Driver Model PMIC command"
1715 This is the pmic command, based on a driver model pmic's API.
1716 Command features are unchanged:
1717 - list - list pmic devices
1718 - pmic dev <id> - show or [set] operating pmic device (NEW)
1719 - pmic dump - dump registers
1720 - pmic read address - read byte of register at address
1721 - pmic write address - write byte to register at address
1722 The only one change for this command is 'dev' subcommand.
1724 config CMD_REGULATOR
1725 bool "Enable Driver Model REGULATOR command"
1726 depends on DM_REGULATOR
1728 This command is based on driver model regulator's API.
1729 User interface features:
1730 - list - list regulator devices
1731 - regulator dev <id> - show or [set] operating regulator device
1732 - regulator info - print constraints info
1733 - regulator status - print operating status
1734 - regulator value <val] <-f> - print/[set] voltage value [uV]
1735 - regulator current <val> - print/[set] current value [uA]
1736 - regulator mode <id> - print/[set] operating mode id
1737 - regulator enable - enable the regulator output
1738 - regulator disable - disable the regulator output
1740 The '-f' (force) option can be used for set the value which exceeds
1741 the limits, which are found in device-tree and are kept in regulator's
1742 uclass platdata structure.
1746 menu "Security commands"
1748 bool "Enable the 'aes' command"
1751 This provides a means to encrypt and decrypt data using the AES
1752 (Advanced Encryption Standard). This algorithm uses a symetric key
1753 and is widely used as a streaming cipher. Different key lengths are
1754 supported by the algorithm but this command only supports 128 bits
1758 bool "Enable the 'blob' command"
1760 This is used with the Freescale secure boot mechanism.
1762 Freescale's SEC block has built-in Blob Protocol which provides
1763 a method for protecting user-defined data across system power
1764 cycles. SEC block protects data in a data structure called a Blob,
1765 which provides both confidentiality and integrity protection.
1767 Encapsulating data as a blob
1768 Each time that the Blob Protocol is used to protect data, a
1769 different randomly generated key is used to encrypt the data.
1770 This random key is itself encrypted using a key which is derived
1771 from SoC's non-volatile secret key and a 16 bit Key identifier.
1772 The resulting encrypted key along with encrypted data is called a
1773 blob. The non-volatile secure key is available for use only during
1776 During decapsulation, the reverse process is performed to get back
1780 blob enc - encapsulating data as a cryptgraphic blob
1781 blob dec - decapsulating cryptgraphic blob to get the data
1785 blob enc src dst len km
1787 Encapsulate and create blob of data $len bytes long
1788 at address $src and store the result at address $dst.
1789 $km is the 16 byte key modifier is also required for
1790 generation/use as key for cryptographic operation. Key
1791 modifier should be 16 byte long.
1793 blob dec src dst len km
1795 Decapsulate the blob of data at address $src and
1796 store result of $len byte at addr $dst.
1797 $km is the 16 byte key modifier is also required for
1798 generation/use as key for cryptographic operation. Key
1799 modifier should be 16 byte long.
1802 bool "Support 'hash' command"
1805 This provides a way to hash data in memory using various supported
1806 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1807 saved to memory or to an environment variable. It is also possible
1808 to verify a hash against data in memory.
1811 bool "Support the 'hvc' command"
1812 depends on ARM_SMCCC
1814 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1815 development and testing.
1818 bool "Support the 'smc' command"
1819 depends on ARM_SMCCC
1821 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1822 development and testing.
1828 Add -v option to verify data against a hash.
1838 bool "Enable the 'tpm' command"
1839 depends on TPM_V1 || TPM_V2
1840 select CMD_TPM_V1 if TPM_V1
1841 select CMD_TPM_V2 if TPM_V2
1843 This provides a means to talk to a TPM from the command line. A wide
1844 range of commands if provided - see 'tpm help' for details. The
1845 command requires a suitable TPM on your board and the correct driver
1851 bool "Enable the 'tpm test' command"
1854 This provides a a series of tests to confirm that the TPMv1.x is
1855 working correctly. The tests cover initialisation, non-volatile RAM,
1856 extend, global lock and checking that timing is within expectations.
1857 The tests pass correctly on Infineon TPMs but may need to be adjusted
1864 menu "Firmware commands"
1866 bool "Enable crosec command"
1870 Enable command-line access to the Chrome OS EC (Embedded
1871 Controller). This provides the 'crosec' command which has
1872 a number of sub-commands for performing EC tasks such as
1873 updating its flash, accessing a small saved context area
1874 and talking to the I2C bus behind the EC (if there is one).
1877 menu "Filesystem commands"
1879 bool "Enable the 'btrsubvol' command"
1882 This enables the 'btrsubvol' command to list subvolumes
1883 of a BTRFS filesystem. There are no special commands for
1884 listing BTRFS directories or loading BTRFS files - this
1885 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1886 when BTRFS is enabled (see FS_BTRFS).
1889 bool "Enable the 'cbfs' command"
1892 Define this to enable support for reading from a Coreboot
1893 filesystem. This is a ROM-based filesystem used for accessing files
1894 on systems that use coreboot as the first boot-loader and then load
1895 U-Boot to actually boot the Operating System. Available commands are
1896 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1899 bool "Enable the 'cramfs' command"
1900 depends on FS_CRAMFS
1902 This provides commands for dealing with CRAMFS (Compressed ROM
1903 filesystem). CRAMFS is useful when space is tight since files are
1904 compressed. Two commands are provided:
1906 cramfsls - lists files in a cramfs image
1907 cramfsload - loads a file from a cramfs image
1910 bool "ext2 command support"
1913 Enables EXT2 FS command
1916 bool "ext4 command support"
1919 Enables EXT4 FS command
1921 config CMD_EXT4_WRITE
1923 bool "ext4 write command support"
1926 Enables EXT4 FS write command
1929 bool "FAT command support"
1932 Support for the FAT fs
1934 config CMD_FS_GENERIC
1935 bool "filesystem commands"
1937 Enables filesystem commands (e.g. load, ls) that work for multiple
1941 bool "fsuuid command"
1943 Enables fsuuid command for filesystem UUID.
1946 bool "jffs2 command"
1949 Enables commands to support the JFFS2 (Journalling Flash File System
1950 version 2) filesystem. This enables fsload, ls and fsinfo which
1951 provide the ability to load files, list directories and obtain
1952 filesystem information.
1955 bool "MTD partition support"
1956 select MTD_DEVICE if (CMD_NAND || NAND)
1958 MTD partitioning tool support.
1959 It is strongly encouraged to avoid using this command
1960 anymore along with 'sf', 'nand', 'onenand'. One can still
1961 declare the partitions in the mtdparts environment variable
1962 but better use the MTD stack and the 'mtd' command instead.
1964 config MTDIDS_DEFAULT
1965 string "Default MTD IDs"
1966 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1968 Defines a default MTD IDs list for use with MTD partitions in the
1969 Linux MTD command line partitions format.
1971 config MTDPARTS_DEFAULT
1972 string "Default MTD partition scheme"
1973 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1975 Defines a default MTD partitioning scheme in the Linux MTD command
1976 line partitions format
1978 config CMD_MTDPARTS_SPREAD
1979 bool "Padd partition size to take account of bad blocks"
1980 depends on CMD_MTDPARTS
1982 This enables the 'spread' sub-command of the mtdparts command.
1983 This command will modify the existing mtdparts variable by increasing
1984 the size of the partitions such that 1) each partition's net size is
1985 at least as large as the size specified in the mtdparts variable and
1986 2) each partition starts on a good block.
1989 bool "reiser - Access to reiserfs filesystems"
1991 This provides two commands which operate on a resierfs filesystem,
1992 commonly used some years ago:
1994 reiserls - list files
1995 reiserload - load a file
1998 bool "yaffs2 - Access of YAFFS2 filesystem"
2002 This provides commands for accessing a YAFFS2 filesystem. Yet
2003 Another Flash Filesystem 2 is a filesystem designed specifically
2004 for NAND flash. It incorporates bad-block management and ensures
2005 that device writes are sequential regardless of filesystem
2009 bool "zfs - Access of ZFS filesystem"
2011 This provides commands to accessing a ZFS filesystem, commonly used
2012 on Solaris systems. Two sub-commands are provided:
2014 zfsls - list files in a directory
2015 zfsload - load a file
2017 See doc/README.zfs for more details.
2021 menu "Debug commands"
2026 The bedbug (emBEDded deBUGger) command provides debugging features
2027 for some PowerPC processors. For details please see the
2028 docuemntation in doc/README.beddbug
2031 bool "diag - Board diagnostics"
2033 This command provides access to board diagnostic tests. These are
2034 called Power-on Self Tests (POST). The command allows listing of
2035 available tests and running either all the tests, or specific tests
2039 bool "irq - Show information about interrupts"
2040 depends on !ARM && !MIPS && !SH
2042 This enables two commands:
2044 interrupts - enable or disable interrupts
2045 irqinfo - print device-specific interrupt information
2048 bool "kgdb - Allow debugging of U-Boot with gdb"
2051 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2052 over a serial link for debugging purposes. This allows
2053 single-stepping, inspecting variables, etc. This is supported only
2054 on PowerPC at present.
2057 bool "log - Generation, control and access to logging"
2060 This provides access to logging features. It allows the output of
2061 log data to be controlled to a limited extent (setting up the default
2062 maximum log level for emitting of records). It also provides access
2063 to a command used for testing the log system.
2066 bool "trace - Support tracing of function calls and timing"
2068 Enables a command to control using of function tracing within
2069 U-Boot. This allows recording of call traces including timing
2070 information. The command can write data to memory for exporting
2071 for analysis (e.g. using bootchart). See doc/README.trace for full
2075 bool "avb - Android Verified Boot 2.0 operations"
2076 depends on AVB_VERIFY
2079 Enables a "avb" command to perform verification of partitions using
2080 Android Verified Boot 2.0 functionality. It includes such subcommands:
2081 avb init - initialize avb2 subsystem
2082 avb read_rb - read rollback index
2083 avb write_rb - write rollback index
2084 avb is_unlocked - check device lock state
2085 avb get_uuid - read and print uuid of a partition
2086 avb read_part - read data from partition
2087 avb read_part_hex - read data from partition and output to stdout
2088 avb write_part - write data to partition
2089 avb verify - run full verification chain
2093 tristate "Enable UBI - Unsorted block images commands"
2096 UBI is a software layer above MTD layer which admits use of LVM-like
2097 logical volumes on top of MTD devices, hides some complexities of
2098 flash chips like wear and bad blocks and provides some other useful
2099 capabilities. Please, consult the MTD web site for more details
2100 (www.linux-mtd.infradead.org). Activate this option if you want
2101 to use U-Boot UBI commands.
2102 It is also strongly encouraged to also enable CONFIG_MTD to get full
2106 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2108 default y if CMD_UBI
2111 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob