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"
175 depends on CMD_BOOTMENU
177 This enables the boot menu, controlled by environment variables
178 defined by the board. The menu starts after running the 'preboot'
179 environmnent variable (if enabled) and before handling the boot delay.
180 See README.bootmenu for more details.
202 Print ".config" contents.
204 If this option is enabled, the ".config" file contents are embedded
205 in the U-Boot image and can be printed on the console by the "config"
206 command. This provides information of which options are enabled on
213 Print console devices and information.
218 Print information about available CPUs. This normally shows the
219 number of CPUs, type (e.g. manufacturer, architecture, product or
220 internal name) and clock frequency. Other information may be
221 available depending on the CPU driver.
227 Print GPL license text
243 Run the command stored in the environment "bootcmd", i.e.
244 "bootd" does the same thing as "run bootcmd".
250 Boot an application image from the memory.
255 Boot the Linux zImage
259 depends on ARM64 || RISCV
262 Boot an AArch64 Linux Kernel image from memory.
266 depends on EFI_LOADER
269 Boot an EFI image from memory.
272 bool "Support booting Linux OS images"
273 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
276 Support booting the Linux kernel directly via a command such as bootm
280 bool "Support booting NetBSD (non-EFI) loader images"
284 Support booting NetBSD via the bootm command.
286 config BOOTM_OPENRTOS
287 bool "Support booting OPENRTOS / FreeRTOS images"
290 Support booting OPENRTOS / FreeRTOS via the bootm command.
293 bool "Support booting Enea OSE images"
296 Support booting Enea OSE images via the bootm command.
299 bool "Support booting Plan9 OS images"
303 Support booting Plan9 images via the bootm command.
306 bool "Support booting RTEMS OS images"
310 Support booting RTEMS images via the bootm command.
313 bool "Support booting VxWorks OS images"
317 Support booting VxWorks images via the bootm command.
319 config CMD_BOOTEFI_HELLO_COMPILE
320 bool "Compile a standard EFI hello world binary for testing"
321 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
324 This compiles a standard EFI hello world application with U-Boot so
325 that it can be used with the test/py testing framework. This is useful
326 for testing that EFI is working at a basic level, and for bringing
327 up EFI support on a new architecture.
329 No additional space will be required in the resulting U-Boot binary
330 when this option is enabled.
332 config CMD_BOOTEFI_HELLO
333 bool "Allow booting a standard EFI hello world for testing"
334 depends on CMD_BOOTEFI_HELLO_COMPILE
336 This adds a standard EFI hello world application to U-Boot so that
337 it can be used with the 'bootefi hello' command. This is useful
338 for testing that EFI is working at a basic level, and for bringing
339 up EFI support on a new architecture.
341 source lib/efi_selftest/Kconfig
347 Add an ANSI terminal boot menu command.
352 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
353 image into RAM, dump image structure information, etc. Those dtb/dtbo
354 files should be merged in one dtb further, which needs to be passed to
355 the kernel, as part of a boot process.
358 bool "bootelf, bootvx"
361 Boot an ELF/vxWorks image from the memory.
364 bool "Flattened Device Tree utility commands"
368 Do FDT related setup before booting into the Operating System.
374 Start an application at a given address.
380 Run the command in the given environment variable.
386 Print header information for application image.
391 List all images found in flash
397 Extract a part of a multi-image.
400 bool "spl export - Export boot information for Falcon boot"
403 Falcon mode allows booting directly from SPL into an Operating
404 System such as Linux, thus skipping U-Boot proper. See
405 doc/README.falcon for full information about how to use this
408 config CMD_SPL_NAND_OFS
409 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
410 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
413 This provides the offset of the command line arguments for Linux
414 when booting from NAND in Falcon mode. See doc/README.falcon
415 for full information about how to use this option (and also see
416 board/gateworks/gw_ventana/README for an example).
418 config CMD_SPL_NOR_OFS
419 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
420 depends on CMD_SPL && SPL_NOR_SUPPORT
423 This provides the offset of the command line arguments or dtb for
424 Linux when booting from NOR in Falcon mode.
426 config CMD_SPL_WRITE_SIZE
427 hex "Size of argument area"
431 This provides the size of the command-line argument area in NAND
432 flash used by Falcon-mode boot. See the documentation until CMD_SPL
436 bool "fitImage update command"
438 Implements the 'fitupd' command, which allows to automatically
439 store software updates present on a TFTP server in NOR Flash
441 config CMD_THOR_DOWNLOAD
442 bool "thor - TIZEN 'thor' download"
444 Implements the 'thor' download protocol. This is a way of
445 downloading a software update over USB from an attached host.
446 There is no documentation about this within the U-Boot source code
447 but you should be able to find something on the interwebs.
450 bool "zboot - x86 boot command"
452 With x86 machines it is common to boot a bzImage file which
453 contains both a kernel and a setup.bin file. The latter includes
454 configuration information from the dark ages which x86 boards still
455 need to pick things out of.
457 Consider using FIT in preference to this since it supports directly
458 booting both 32- and 64-bit kernels, as well as secure boot.
459 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
463 menu "Environment commands"
466 bool "ask for env variable"
468 Ask for environment variable
486 Edit environment variable.
491 Allow for searching environment variables
497 Save all environment variables into the compiled-in persistent
503 depends on CMD_SAVEENV
505 Erase environment variables from the compiled-in persistent
508 config CMD_ENV_EXISTS
512 Check if a variable is defined in the environment for use in
515 config CMD_ENV_CALLBACK
516 bool "env callbacks - print callbacks and their associated variables"
518 Some environment variable have callbacks defined by
519 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
520 For example changing "baudrate" adjust the serial baud rate. This
521 command lists the currently defined callbacks.
524 bool "env flags -print variables that have non-default flags"
526 Some environment variables have special flags that control their
527 behaviour. For example, serial# can only be written once and cannot
528 be deleted. This command shows the variables that have special
531 config CMD_NVEDIT_EFI
532 bool "env [set|print] -e - set/print UEFI variables"
533 depends on EFI_LOADER
537 UEFI variables are encoded as some form of U-Boot variables.
538 If enabled, we are allowed to set/print UEFI variables using
539 "env" command with "-e" option without knowing details.
541 config CMD_NVEDIT_INFO
542 bool "env info - print or evaluate environment information"
544 Print environment information:
545 - env_valid : is environment valid
546 - env_ready : is environment imported into hash table
547 - env_use_default : is default environment used
549 This command can be optionally used for evaluation in scripts:
550 [-d] : evaluate whether default environment is used
551 [-p] : evaluate whether environment can be persisted
552 The result of multiple evaluations will be combined with AND.
556 menu "Memory commands"
561 Compute binary operations (xor, or, and) of byte arrays of arbitrary
562 size from memory and store the result in memory or the environment.
575 Add -v option to verify data against a crc32 checksum.
578 bool "eeprom - EEPROM subsystem"
580 (deprecated, needs conversion to driver model)
581 Provides commands to read and write EEPROM (Electrically Erasable
582 Programmable Read Only Memory) chips that are connected over an
585 config CMD_EEPROM_LAYOUT
586 bool "Enable layout-aware eeprom commands"
587 depends on CMD_EEPROM
589 (deprecated, needs conversion to driver model)
590 When enabled, additional eeprom sub-commands become available.
592 eeprom print - prints the contents of the eeprom in a human-readable
593 way (eeprom layout fields, and data formatted to be fit for human
596 eeprom update - allows user to update eeprom fields by specifying
597 the field name, and providing the new data in a human readable format
598 (same format as displayed by the eeprom print command).
600 Both commands can either auto detect the layout, or be told which
604 __weak int parse_layout_version(char *str)
605 - override to provide your own layout name parsing
606 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
608 - override to setup the layout metadata based on the version
609 __weak int eeprom_layout_detect(unsigned char *data)
610 - override to provide your own algorithm for detecting layout
613 - contains various printing and updating functions for common
614 types of eeprom fields. Can be used for defining
617 config EEPROM_LAYOUT_HELP_STRING
618 string "Tells user what layout names are supported"
619 depends on CMD_EEPROM_LAYOUT
620 default "<not defined>"
622 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
628 Infinite write loop on address range
635 Compute MD5 checksum.
640 depends on CMD_MD5SUM
642 Add -v option to verify data against an MD5 checksum.
647 Display memory information.
650 bool "md, mm, nm, mw, cp, cmp, base, loop"
655 mm - memory modify (auto-incrementing address)
656 nm - memory modify (constant address)
657 mw - memory write (fill)
660 base - print or set address offset
661 loop - initialize loop on address range
664 bool "Enable cyclic md/mw commands"
665 depends on CMD_MEMORY
667 Add the "mdc" and "mwc" memory commands. These are cyclic
672 This command will print 4 bytes (10,11,12,13) each 500 ms.
674 => mwc.l 100 12345678 10
675 This command will write 12345678 to address 100 all 10 ms.
680 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
682 random - fill memory with random data
687 Simple RAM read/write test.
691 config SYS_ALT_MEMTEST
692 bool "Alternative test"
694 Use a more complete alternative memory test.
701 mdc - memory display cyclic
702 mwc - memory write cyclic
708 Compute SHA1 checksum.
710 config SHA1SUM_VERIFY
712 depends on CMD_SHA1SUM
714 Add -v option to verify data against a SHA1 checksum.
717 bool "strings - display strings in memory"
719 This works similarly to the Unix 'strings' command except that it
720 works with a memory range. String of printable characters found
721 within the range are displayed. The minimum number of characters
722 for a sequence to be considered a string can be provided.
726 menu "Compression commands"
730 default y if CMD_BOOTI
733 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
738 default y if CMD_BOOTI
740 Uncompress a zip-compressed memory region.
745 Compress a memory region with zlib deflate method.
749 menu "Device access commands"
752 #depends on FLASH_CFI_DRIVER
755 ARM Ltd reference designs flash partition access
758 bool "adc - Access Analog to Digital Converters info and data"
762 Shows ADC device info and permit printing one-shot analog converted
763 data from a named Analog to Digital Converter.
768 depends on PARTITIONS
770 Read/modify/write the fields of Bootloader Control Block, usually
771 stored on the flash "misc" partition with its structure defined in:
772 https://android.googlesource.com/platform/bootable/recovery/+/master/
773 bootloader_message/include/bootloader_message/bootloader_message.h
775 Some real-life use-cases include (but are not limited to):
776 - Determine the "boot reason" (and act accordingly):
777 https://source.android.com/devices/bootloader/boot-reason
778 - Get/pass a list of commands from/to recovery:
779 https://android.googlesource.com/platform/bootable/recovery
780 - Inspect/dump the contents of the BCB fields
783 bool "bind/unbind - Bind or unbind a device to/from a driver"
786 Bind or unbind a device to/from a driver from the command line.
787 This is useful in situations where a device may be handled by several
788 drivers. For example, this can be used to bind a UDC to the usb ether
789 gadget driver from the command line.
792 bool "clk - Show clock frequencies"
795 Shows clock frequences by calling a sock_clk_dump() hook function.
796 This is depreated in favour of using the CLK uclass and accessing
797 clock values from associated drivers. However currently no command
801 bool "demo - Demonstration commands for driver model"
804 Provides a 'demo' command which can be used to play around with
805 driver model. To use this properly you will need to enable one or
806 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
807 Otherwise you will always get an empty list of devices. The demo
808 devices are defined in the sandbox device tree, so the easiest
809 option is to use sandbox and pass the -d point to sandbox's
816 Enables the command "dfu" which is used to have U-Boot create a DFU
817 class device via USB. This command requires that the "dfu_alt_info"
818 environment variable be set and define the alt settings to expose to
822 bool "dm - Access to driver model information"
825 Provides access to driver model data structures and information,
826 such as a list of devices, list of uclasses and the state of each
827 device (e.g. activated). This is not required for operation, but
828 can be useful to see the state of driver model for debugging or
832 bool "fastboot - Android fastboot support"
835 This enables the command "fastboot" which enables the Android
836 fastboot mode for the platform. Fastboot is a protocol for
837 downloading images, flashing and device control used on
838 Android devices. Fastboot requires either the network stack
839 enabled or support for acting as a USB device.
841 See doc/android/fastboot.txt for more information.
844 bool "fdcboot - Boot from floppy device"
846 The 'fdtboot' command allows booting an image from a floppy disk.
849 bool "flinfo, erase, protect"
853 flinfo - print FLASH memory information
855 protect - enable or disable FLASH write protection
864 config CMD_FPGA_LOADBP
865 bool "fpga loadbp - load partial bitstream (Xilinx only)"
868 Supports loading an FPGA device from a bitstream buffer containing
871 config CMD_FPGA_LOADFS
872 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
875 Supports loading an FPGA device from a FAT filesystem.
877 config CMD_FPGA_LOADMK
878 bool "fpga loadmk - load bitstream from image"
881 Supports loading an FPGA device from a image generated by mkimage.
883 config CMD_FPGA_LOADP
884 bool "fpga loadp - load partial bitstream"
887 Supports loading an FPGA device from a bitstream buffer containing
890 config CMD_FPGA_LOAD_SECURE
891 bool "fpga loads - loads secure bitstreams (Xilinx only)"
894 Enables the fpga loads command which is used to load secure
895 (authenticated or encrypted or both) bitstreams on to FPGA.
898 bool "fpgad - dump FPGA registers"
900 (legacy, needs conversion to driver model)
901 Provides a way to dump FPGA registers by calling the board-specific
902 fpga_get_reg() function. This functions similarly to the 'md'
906 bool "fuse - support for the fuse subssystem"
908 (deprecated - needs conversion to driver model)
909 This allows reading, sensing, programming or overriding fuses
910 which control the behaviour of the device. The command uses the
919 bool "GPT (GUID Partition Table) command"
921 select HAVE_BLOCK_DEVICE
922 select PARTITION_UUIDS
925 Enable the 'gpt' command to ready and write GPT style partition
929 bool "GPT Random UUID generation"
932 Enable the generation of partitions with random UUIDs if none
935 config CMD_GPT_RENAME
936 bool "GPT partition renaming commands"
939 Enables the 'gpt' command to interchange names on two GPT
940 partitions via the 'gpt swap' command or to rename single
941 partitions via the 'rename' command.
944 bool "ide - Support for IDE drivers"
947 Provides an 'ide' command which allows accessing the IDE drive,
948 reseting the IDE interface, printing the partition table and
949 geting device info. It also enables the 'diskboot' command which
950 permits booting from an IDE drive.
953 bool "io - Support for performing I/O accesses"
955 Provides an 'iod' command to display I/O space and an 'iow' command
956 to write values to the I/O space. This can be useful for manually
957 checking the state of devices during boot when debugging device
961 bool "iotrace - Support for tracing I/O activity"
963 Provides an 'iotrace' command which supports recording I/O reads and
964 writes in a trace buffer in memory . It also maintains a checksum
965 of the trace records (even if space is exhausted) so that the
966 sequence of I/O accesses can be verified.
968 When debugging drivers it is useful to see what I/O accesses were
969 done and in what order.
971 Even if the individual accesses are of little interest it can be
972 useful to verify that the access pattern is consistent each time
973 an operation is performed. In this case a checksum can be used to
974 characterise the operation of a driver. The checksum can be compared
975 across different runs of the operation to verify that the driver is
978 In particular, when performing major refactoring of the driver, where
979 the access pattern should not change, the checksum provides assurance
980 that the refactoring work has not broken the driver.
982 This works by sneaking into the io.h heder for an architecture and
983 redirecting I/O accesses through iotrace's tracing mechanism.
985 For now no commands are provided to examine the trace buffer. The
986 format is fairly simple, so 'md' is a reasonable substitute.
988 Note: The checksum feature is only useful for I/O regions where the
989 contents do not change outside of software control. Where this is not
990 suitable you can fall back to manually comparing the addresses. It
991 might be useful to enhance tracing to only checksum the accesses and
992 not the data read/written.
1002 bool "w1 - Support for Dallas 1-Wire protocol"
1004 Dallas 1-wire protocol support
1010 Load a binary file over serial line.
1016 Load an S-Record file over serial line
1021 MMC memory mapped support.
1024 bool "Enable support for RPMB in the mmc command"
1027 Enable the commands for reading, writing and programming the
1028 key for the Replay Protection Memory Block partition in eMMC.
1030 config CMD_MMC_SWRITE
1032 depends on CMD_MMC && MMC_WRITE
1035 Enable support for the "mmc swrite" command to write Android sparse
1040 select MTD_PARTITIONS
1042 MTD commands support.
1046 default y if NAND_SUNXI
1051 config CMD_NAND_TRIMFFS
1052 bool "nand write.trimffs"
1053 default y if ARCH_SUNXI
1055 Allows one to skip empty pages when flashing something on a NAND.
1057 config CMD_NAND_LOCK_UNLOCK
1058 bool "nand lock/unlock"
1060 NAND locking support.
1062 config CMD_NAND_TORTURE
1065 NAND torture support.
1074 NVM Express device support
1077 bool "onenand - access to onenand device"
1079 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1080 various useful features. This command allows reading, writing,
1081 and erasing blocks. It allso provides a way to show and change
1082 bad blocks, and test the device.
1087 Enable the 'osd' command which allows to query information from and
1088 write text data to a on-screen display (OSD) device; a virtual device
1089 associated with a display capable of displaying a text overlay on the
1090 display it's associated with..
1094 select HAVE_BLOCK_DEVICE
1095 select PARTITION_UUIDS
1097 Read and display information about the partition table on
1101 bool "pci - Access PCI devices"
1103 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1104 used on some devices to allow the CPU to communicate with its
1105 peripherals. Sub-commands allow bus enumeration, displaying and
1106 changing configuration space and a few other features.
1109 bool "pinmux - show pins muxing"
1110 default y if PINCTRL
1112 Parse all available pin-controllers and show pins muxing. This
1113 is useful for debug purpoer to check the pin muxing and to know if
1114 a pin is configured as a GPIO or as an alternate function.
1119 Poweroff/Shutdown the system
1122 bool "read - Read binary data from a partition"
1124 Provides low-level access to the data in a partition.
1126 config CMD_REMOTEPROC
1128 depends on REMOTEPROC
1130 Support for Remote Processor control
1133 bool "sata - Access SATA subsystem"
1136 SATA (Serial Advanced Technology Attachment) is a serial bus
1137 standard for connecting to hard drives and other storage devices.
1138 This command provides information about attached devices and allows
1139 reading, writing and other operations.
1141 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1142 Attachment, where AT refers to an IBM AT (Advanced Technology)
1143 computer released in 1984.
1146 bool "saves - Save a file over serial in S-Record format"
1148 Provides a way to save a binary file using the Motorola S-Record
1149 format over the serial line.
1152 bool "scsi - Access to SCSI devices"
1155 This provides a 'scsi' command which provides access to SCSI (Small
1156 Computer System Interface) devices. The command provides a way to
1157 scan the bus, reset the bus, read and write data and get information
1161 bool "sdram - Print SDRAM configuration information"
1163 Provides information about attached SDRAM. This assumed that the
1164 SDRAM has an EEPROM with information that can be read using the
1165 I2C bus. This is only available on some boards.
1169 depends on DM_SPI_FLASH || SPI_FLASH
1174 bool "sf test - Allow testing of SPI flash"
1177 Provides a way to test that SPI flash is working correctly. The
1178 test is destructive, in that an area of SPI flash must be provided
1179 for the test to use. Performance information is also provided,
1180 measuring the performance of reading, writing and erasing in
1181 Mbps (Million Bits Per Second). This value should approximately
1182 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1183 everything is working properly.
1186 bool "sspi - Command to access spi device"
1189 SPI utility command.
1191 config DEFAULT_SPI_BUS
1192 int "default spi bus used by sspi command"
1196 config DEFAULT_SPI_MODE
1197 hex "default spi mode used by sspi command (see include/spi.h)"
1202 bool "tsi148 - Command to access tsi148 device"
1204 This provides various sub-commands to initialise and configure the
1205 Turndra tsi148 device. See the command help for full details.
1208 bool "universe - Command to set up the Turndra Universe controller"
1210 This allows setting up the VMEbus provided by this controller.
1211 See the command help for full details.
1215 select HAVE_BLOCK_DEVICE
1221 select USB_FUNCTION_SDP
1223 Enables the command "sdp" which is used to have U-Boot emulating the
1224 Serial Download Protocol (SDP) via USB.
1228 depends on USB_FUNCTION_ROCKUSB
1230 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1231 read/write info, image to/from devices. This enable rockusb command
1232 support to communication with rockusb device. for more detail about
1233 this command, please read doc/README.rockusb.
1235 config CMD_USB_MASS_STORAGE
1236 bool "UMS usb mass storage"
1237 select USB_FUNCTION_MASS_STORAGE
1239 USB mass storage support
1246 VirtIO block device support
1252 This provides commands to control the watchdog timer devices.
1258 Enable the command "axi" for accessing AXI (Advanced eXtensible
1259 Interface) busses, a on-chip interconnect specification for managing
1260 functional blocks in SoC designs, which is also often used in designs
1261 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1265 menu "Shell scripting commands"
1271 Echo args to console
1277 Return true/false on integer compare.
1283 Run script from memory
1289 Evaluate boolean and math expressions and store the result in an env
1291 Also supports loading the value at a memory location into a variable.
1292 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1296 menu "Android support commands"
1298 config CMD_AB_SELECT
1301 depends on ANDROID_AB
1303 On Android devices with more than one boot slot (multiple copies of
1304 the kernel and system images) this provides a command to select which
1305 slot should be used to boot from and register the boot attempt. This
1306 is used by the new A/B update model where one slot is updated in the
1307 background while running from the other slot.
1314 bool "Network commands"
1324 bootp - boot image via network using BOOTP/TFTP protocol
1328 depends on CMD_BOOTP
1330 Boot image via network using DHCP/TFTP protocol
1332 config BOOTP_BOOTPATH
1333 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1335 depends on CMD_BOOTP
1337 Even though the config is called BOOTP_BOOTPATH, it stores the
1338 path in the variable 'rootpath'.
1341 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1343 depends on CMD_BOOTP
1345 The primary DNS server is stored as 'dnsip'. If two servers are
1346 returned, you must set BOOTP_DNS2 to store that second server IP
1350 bool "Store 'dnsip2' from BOOTP/DHCP server"
1351 depends on BOOTP_DNS
1353 If a DHCP client requests the DNS server IP from a DHCP server,
1354 it is possible that more than one DNS serverip is offered to the
1355 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1356 server IP will be stored in the additional environment
1357 variable "dnsip2". The first DNS serverip is always
1358 stored in the variable "dnsip", when BOOTP_DNS is defined.
1360 config BOOTP_GATEWAY
1361 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1363 depends on CMD_BOOTP
1365 config BOOTP_HOSTNAME
1366 bool "Request & store 'hostname' from BOOTP/DHCP server"
1368 depends on CMD_BOOTP
1370 The name may or may not be qualified with the local domain name.
1372 config BOOTP_PREFER_SERVERIP
1373 bool "serverip variable takes precedent over DHCP server IP."
1374 depends on CMD_BOOTP
1376 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1378 With this option enabled, the 'serverip' variable in the environment
1379 takes precedence over DHCP server IP and will only be set by the DHCP
1380 server if not already set in the environment.
1382 config BOOTP_SUBNETMASK
1383 bool "Request & store 'netmask' from BOOTP/DHCP server"
1385 depends on CMD_BOOTP
1387 config BOOTP_NTPSERVER
1388 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1389 depends on CMD_BOOTP
1394 Selecting this will allow capturing all Ethernet packets and store
1395 them in physical memory in a PCAP formated file,
1396 later to be analyzed by PCAP reader application (IE. WireShark).
1399 bool "Send PXE client arch to BOOTP/DHCP server"
1401 depends on CMD_BOOTP && CMD_PXE
1403 Supported for ARM, ARM64, and x86 for now.
1405 config BOOTP_PXE_CLIENTARCH
1407 depends on BOOTP_PXE
1408 default 0x16 if ARM64
1412 config BOOTP_VCI_STRING
1414 depends on CMD_BOOTP
1415 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1416 default "U-Boot.armv8" if ARM64
1417 default "U-Boot.arm" if ARM
1424 tftpboot - boot image via network using TFTP protocol
1428 depends on CMD_TFTPBOOT
1430 TFTP put command, for uploading files to a server
1434 depends on CMD_TFTPBOOT
1436 Act as a TFTP server and boot the first received file
1438 config NET_TFTP_VARS
1439 bool "Control TFTP timeout and count through environment"
1440 depends on CMD_TFTPBOOT
1443 If set, allows controlling the TFTP timeout through the
1444 environment variable tftptimeout, and the TFTP maximum
1445 timeout count through the variable tftptimeoutcountmax.
1446 If unset, timeout and maximum are hard-defined as 1 second
1447 and 10 timouts per TFTP transfer.
1452 Boot image via network using RARP/TFTP protocol
1458 Boot image via network using NFS protocol.
1463 Enable MII utility commands.
1468 Send ICMP ECHO_REQUEST to network host
1473 Perform CDP network configuration
1478 Synchronize RTC via network
1483 Lookup the IP of a hostname
1485 config CMD_LINK_LOCAL
1489 Acquire a network IP address using the link-local protocol
1496 Allow control of L2 Ethernet switch commands. These are supported
1497 by the vsc9953 Ethernet driver at present. Sub-commands allow
1498 operations such as enabling / disabling a port and
1499 viewing/maintaining the filtering database (FDB)
1505 Boot image via network using PXE protocol
1510 Wait for wake-on-lan Magic Packet
1514 menu "Misc commands"
1517 bool "Enable 'bmp' command"
1518 depends on LCD || DM_VIDEO || VIDEO
1520 This provides a way to obtain information about a BMP-format iamge
1521 and to display it. BMP (which presumably stands for BitMaP) is a
1522 file format defined by Microsoft which supports images of various
1523 depths, formats and compression methods. Headers on the file
1524 determine the formats used. This command can be used by first loading
1525 the image into RAM, then using this command to look at it or display
1528 config CMD_BOOTCOUNT
1530 depends on BOOTCOUNT_LIMIT
1532 Enable the bootcount command, which allows interrogation and
1533 reset of the bootcounter.
1536 bool "Enable board-specific commands"
1538 (deprecated: instead, please define a Kconfig option for each command)
1540 Some boards have board-specific commands which are only enabled
1541 during developemnt and need to be turned off for production. This
1542 option provides a way to control this. The commands that are enabled
1543 vary depending on the board.
1545 config CMD_BKOPS_ENABLE
1546 bool "mmc bkops enable"
1550 Enable command for setting manual background operations handshake
1551 on a eMMC device. The feature is optionally available on eMMC devices
1552 conforming to standard >= 4.41.
1554 config CMD_BLOCK_CACHE
1555 bool "blkcache - control and stats for block cache"
1556 depends on BLOCK_CACHE
1557 default y if BLOCK_CACHE
1559 Enable the blkcache command, which can be used to control the
1560 operation of the cache functions.
1561 This is most useful when fine-tuning the operation of the cache
1562 during development, but also allows the cache to be disabled when
1563 it might hurt performance (e.g. when using the ums command).
1566 bool "icache or dcache"
1568 Enable the "icache" and "dcache" commands
1570 config CMD_CONITRACE
1571 bool "conitrace - trace console input codes"
1573 Enable the 'conitrace' command which displays the codes received
1574 from the console input as hexadecimal numbers.
1577 bool "Enable clear screen command 'cls'"
1578 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1581 Enable the 'cls' command which clears the screen contents
1582 on video frame buffer.
1585 bool "efidebug - display/configure UEFI environment"
1586 depends on EFI_LOADER
1587 select EFI_DEVICE_PATH_TO_TEXT
1590 Enable the 'efidebug' command which provides a subset of UEFI
1591 shell utility with simplified functionality. It will be useful
1592 particularly for managing boot parameters as well as examining
1593 various EFI status for debugging.
1595 config CMD_EXCEPTION
1596 bool "exception - raise exception"
1597 depends on ARM || RISCV || X86
1599 Enable the 'exception' command which allows to raise an exception.
1606 Enable the 'led' command which allows for control of LEDs supported
1607 by the board. The LEDs can be listed with 'led list' and controlled
1608 with led on/off/togle/blink. Any LED drivers can be controlled with
1609 this command, e.g. led_gpio.
1615 Enable the 'date' command for getting/setting the time/date in RTC
1621 Run commands and summarize execution time.
1624 bool "gettime - read elapsed time"
1626 Enable the 'gettime' command which reads the elapsed time since
1627 U-Boot started running. This shows the time in seconds and
1628 milliseconds. See also the 'bootstage' command which provides more
1629 flexibility for boot timing.
1631 # TODO: rename to CMD_SLEEP
1636 Delay execution for some time
1639 bool "support for multiprocessor"
1641 This provides an option to brinup
1642 different processors in multiprocessor
1648 Access the system timer.
1654 This provides basic access to the U-Boot's sound support. The main
1655 feature is to play a beep.
1657 sound init - set up sound system
1658 sound play - play a sound
1664 This provides access to the QEMU firmware interface. The main
1665 feature is to allow easy loading of files passed to qemu-system
1666 via -kernel / -initrd
1668 source "cmd/mvebu/Kconfig"
1671 bool "terminal - provides a way to attach a serial terminal"
1673 Provides a 'cu'-like serial terminal command. This can be used to
1674 access other serial ports from the system console. The terminal
1675 is very simple with no special processing of characters. As with
1676 cu, you can press ~. (tilde followed by period) to exit.
1679 bool "uuid, guid - generation of unique IDs"
1682 This enables two commands:
1684 uuid - generate random Universally Unique Identifier
1685 guid - generate Globally Unique Identifier based on random UUID
1687 The two commands are very similar except for the endianness of the
1692 source "cmd/ti/Kconfig"
1694 config CMD_BOOTSTAGE
1695 bool "Enable the 'bootstage' command"
1696 depends on BOOTSTAGE
1698 Add a 'bootstage' command which supports printing a report
1699 and un/stashing of bootstage data.
1701 menu "Power commands"
1703 bool "Enable Driver Model PMIC command"
1706 This is the pmic command, based on a driver model pmic's API.
1707 Command features are unchanged:
1708 - list - list pmic devices
1709 - pmic dev <id> - show or [set] operating pmic device (NEW)
1710 - pmic dump - dump registers
1711 - pmic read address - read byte of register at address
1712 - pmic write address - write byte to register at address
1713 The only one change for this command is 'dev' subcommand.
1715 config CMD_REGULATOR
1716 bool "Enable Driver Model REGULATOR command"
1717 depends on DM_REGULATOR
1719 This command is based on driver model regulator's API.
1720 User interface features:
1721 - list - list regulator devices
1722 - regulator dev <id> - show or [set] operating regulator device
1723 - regulator info - print constraints info
1724 - regulator status - print operating status
1725 - regulator value <val] <-f> - print/[set] voltage value [uV]
1726 - regulator current <val> - print/[set] current value [uA]
1727 - regulator mode <id> - print/[set] operating mode id
1728 - regulator enable - enable the regulator output
1729 - regulator disable - disable the regulator output
1731 The '-f' (force) option can be used for set the value which exceeds
1732 the limits, which are found in device-tree and are kept in regulator's
1733 uclass platdata structure.
1737 menu "Security commands"
1739 bool "Enable the 'aes' command"
1742 This provides a means to encrypt and decrypt data using the AES
1743 (Advanced Encryption Standard). This algorithm uses a symetric key
1744 and is widely used as a streaming cipher. Different key lengths are
1745 supported by the algorithm but this command only supports 128 bits
1749 bool "Enable the 'blob' command"
1751 This is used with the Freescale secure boot mechanism.
1753 Freescale's SEC block has built-in Blob Protocol which provides
1754 a method for protecting user-defined data across system power
1755 cycles. SEC block protects data in a data structure called a Blob,
1756 which provides both confidentiality and integrity protection.
1758 Encapsulating data as a blob
1759 Each time that the Blob Protocol is used to protect data, a
1760 different randomly generated key is used to encrypt the data.
1761 This random key is itself encrypted using a key which is derived
1762 from SoC's non-volatile secret key and a 16 bit Key identifier.
1763 The resulting encrypted key along with encrypted data is called a
1764 blob. The non-volatile secure key is available for use only during
1767 During decapsulation, the reverse process is performed to get back
1771 blob enc - encapsulating data as a cryptgraphic blob
1772 blob dec - decapsulating cryptgraphic blob to get the data
1776 blob enc src dst len km
1778 Encapsulate and create blob of data $len bytes long
1779 at address $src and store the result at address $dst.
1780 $km is the 16 byte key modifier is also required for
1781 generation/use as key for cryptographic operation. Key
1782 modifier should be 16 byte long.
1784 blob dec src dst len km
1786 Decapsulate the blob of data at address $src and
1787 store result of $len byte at addr $dst.
1788 $km is the 16 byte key modifier is also required for
1789 generation/use as key for cryptographic operation. Key
1790 modifier should be 16 byte long.
1793 bool "Support 'hash' command"
1796 This provides a way to hash data in memory using various supported
1797 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1798 saved to memory or to an environment variable. It is also possible
1799 to verify a hash against data in memory.
1802 bool "Support the 'hvc' command"
1803 depends on ARM_SMCCC
1805 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1806 development and testing.
1809 bool "Support the 'smc' command"
1810 depends on ARM_SMCCC
1812 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1813 development and testing.
1819 Add -v option to verify data against a hash.
1829 bool "Enable the 'tpm' command"
1830 depends on TPM_V1 || TPM_V2
1831 select CMD_TPM_V1 if TPM_V1
1832 select CMD_TPM_V2 if TPM_V2
1834 This provides a means to talk to a TPM from the command line. A wide
1835 range of commands if provided - see 'tpm help' for details. The
1836 command requires a suitable TPM on your board and the correct driver
1842 bool "Enable the 'tpm test' command"
1845 This provides a a series of tests to confirm that the TPMv1.x is
1846 working correctly. The tests cover initialisation, non-volatile RAM,
1847 extend, global lock and checking that timing is within expectations.
1848 The tests pass correctly on Infineon TPMs but may need to be adjusted
1855 menu "Firmware commands"
1857 bool "Enable crosec command"
1861 Enable command-line access to the Chrome OS EC (Embedded
1862 Controller). This provides the 'crosec' command which has
1863 a number of sub-commands for performing EC tasks such as
1864 updating its flash, accessing a small saved context area
1865 and talking to the I2C bus behind the EC (if there is one).
1868 menu "Filesystem commands"
1870 bool "Enable the 'btrsubvol' command"
1873 This enables the 'btrsubvol' command to list subvolumes
1874 of a BTRFS filesystem. There are no special commands for
1875 listing BTRFS directories or loading BTRFS files - this
1876 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1877 when BTRFS is enabled (see FS_BTRFS).
1880 bool "Enable the 'cbfs' command"
1883 Define this to enable support for reading from a Coreboot
1884 filesystem. This is a ROM-based filesystem used for accessing files
1885 on systems that use coreboot as the first boot-loader and then load
1886 U-Boot to actually boot the Operating System. Available commands are
1887 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1890 bool "Enable the 'cramfs' command"
1891 depends on FS_CRAMFS
1893 This provides commands for dealing with CRAMFS (Compressed ROM
1894 filesystem). CRAMFS is useful when space is tight since files are
1895 compressed. Two commands are provided:
1897 cramfsls - lists files in a cramfs image
1898 cramfsload - loads a file from a cramfs image
1901 bool "ext2 command support"
1904 Enables EXT2 FS command
1907 bool "ext4 command support"
1910 Enables EXT4 FS command
1912 config CMD_EXT4_WRITE
1914 bool "ext4 write command support"
1917 Enables EXT4 FS write command
1920 bool "FAT command support"
1923 Support for the FAT fs
1925 config CMD_FS_GENERIC
1926 bool "filesystem commands"
1928 Enables filesystem commands (e.g. load, ls) that work for multiple
1932 bool "fsuuid command"
1934 Enables fsuuid command for filesystem UUID.
1937 bool "jffs2 command"
1940 Enables commands to support the JFFS2 (Journalling Flash File System
1941 version 2) filesystem. This enables fsload, ls and fsinfo which
1942 provide the ability to load files, list directories and obtain
1943 filesystem information.
1946 bool "MTD partition support"
1947 select MTD_DEVICE if (CMD_NAND || NAND)
1949 MTD partitioning tool support.
1950 It is strongly encouraged to avoid using this command
1951 anymore along with 'sf', 'nand', 'onenand'. One can still
1952 declare the partitions in the mtdparts environment variable
1953 but better use the MTD stack and the 'mtd' command instead.
1955 config MTDIDS_DEFAULT
1956 string "Default MTD IDs"
1957 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1959 Defines a default MTD IDs list for use with MTD partitions in the
1960 Linux MTD command line partitions format.
1962 config MTDPARTS_DEFAULT
1963 string "Default MTD partition scheme"
1964 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1966 Defines a default MTD partitioning scheme in the Linux MTD command
1967 line partitions format
1969 config CMD_MTDPARTS_SPREAD
1970 bool "Padd partition size to take account of bad blocks"
1971 depends on CMD_MTDPARTS
1973 This enables the 'spread' sub-command of the mtdparts command.
1974 This command will modify the existing mtdparts variable by increasing
1975 the size of the partitions such that 1) each partition's net size is
1976 at least as large as the size specified in the mtdparts variable and
1977 2) each partition starts on a good block.
1980 bool "reiser - Access to reiserfs filesystems"
1982 This provides two commands which operate on a resierfs filesystem,
1983 commonly used some years ago:
1985 reiserls - list files
1986 reiserload - load a file
1989 bool "yaffs2 - Access of YAFFS2 filesystem"
1993 This provides commands for accessing a YAFFS2 filesystem. Yet
1994 Another Flash Filesystem 2 is a filesystem designed specifically
1995 for NAND flash. It incorporates bad-block management and ensures
1996 that device writes are sequential regardless of filesystem
2000 bool "zfs - Access of ZFS filesystem"
2002 This provides commands to accessing a ZFS filesystem, commonly used
2003 on Solaris systems. Two sub-commands are provided:
2005 zfsls - list files in a directory
2006 zfsload - load a file
2008 See doc/README.zfs for more details.
2012 menu "Debug commands"
2017 The bedbug (emBEDded deBUGger) command provides debugging features
2018 for some PowerPC processors. For details please see the
2019 docuemntation in doc/README.beddbug
2022 bool "diag - Board diagnostics"
2024 This command provides access to board diagnostic tests. These are
2025 called Power-on Self Tests (POST). The command allows listing of
2026 available tests and running either all the tests, or specific tests
2030 bool "irq - Show information about interrupts"
2031 depends on !ARM && !MIPS && !SH
2033 This enables two commands:
2035 interrupts - enable or disable interrupts
2036 irqinfo - print device-specific interrupt information
2039 bool "kgdb - Allow debugging of U-Boot with gdb"
2042 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2043 over a serial link for debugging purposes. This allows
2044 single-stepping, inspecting variables, etc. This is supported only
2045 on PowerPC at present.
2048 bool "log - Generation, control and access to logging"
2051 This provides access to logging features. It allows the output of
2052 log data to be controlled to a limited extent (setting up the default
2053 maximum log level for emitting of records). It also provides access
2054 to a command used for testing the log system.
2057 bool "trace - Support tracing of function calls and timing"
2059 Enables a command to control using of function tracing within
2060 U-Boot. This allows recording of call traces including timing
2061 information. The command can write data to memory for exporting
2062 for analysis (e.g. using bootchart). See doc/README.trace for full
2066 bool "avb - Android Verified Boot 2.0 operations"
2067 depends on AVB_VERIFY
2070 Enables a "avb" command to perform verification of partitions using
2071 Android Verified Boot 2.0 functionality. It includes such subcommands:
2072 avb init - initialize avb2 subsystem
2073 avb read_rb - read rollback index
2074 avb write_rb - write rollback index
2075 avb is_unlocked - check device lock state
2076 avb get_uuid - read and print uuid of a partition
2077 avb read_part - read data from partition
2078 avb read_part_hex - read data from partition and output to stdout
2079 avb write_part - write data to partition
2080 avb verify - run full verification chain
2084 tristate "Enable UBI - Unsorted block images commands"
2087 UBI is a software layer above MTD layer which admits use of LVM-like
2088 logical volumes on top of MTD devices, hides some complexities of
2089 flash chips like wear and bad blocks and provides some other useful
2090 capabilities. Please, consult the MTD web site for more details
2091 (www.linux-mtd.infradead.org). Activate this option if you want
2092 to use U-Boot UBI commands.
2093 It is also strongly encouraged to also enable CONFIG_MTD to get full
2097 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2099 default y if CMD_UBI
2102 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob