1 menu "Command line interface"
4 bool "Support U-Boot commands"
7 Enable U-Boot's command-line functions. This provides a means
8 to enter commands into U-Boot for a wide variety of purposes. It
9 also allows scripts (containing commands) to be executed.
10 Various commands and command categorys can be indivdually enabled.
11 Depending on the number of commands enabled, this can add
12 substantially to the size of U-Boot.
18 This option enables the "hush" shell (from Busybox) as command line
19 interpreter, thus enabling powerful command line syntax like
20 if...then...else...fi conditionals or `&&' and '||'
21 constructs ("shell scripts").
23 If disabled, you get the old, much simpler behaviour with a somewhat
24 smaller memory footprint.
26 config CMDLINE_EDITING
27 bool "Enable command line editing"
31 Enable editing and History functions for interactive command line
35 bool "Enable auto complete using TAB"
39 Enable auto completion of commands using TAB.
42 bool "Enable long help messages"
46 Defined when you want long help messages included
47 Do not set this option when short of memory.
53 This string is displayed in the command line to the left of the
57 string "Command execution tracer"
61 This option enables the possiblity to print all commands before
62 executing them and after all variables are evaluated (similar
63 to Bash's xtrace/'set -x' feature).
64 To enable the tracer a variable "xtrace" needs to be defined in
67 menu "Autoboot options"
73 This enables the autoboot. See doc/README.autoboot for detail.
76 bool "Stop autobooting via specific input key / string"
79 This option enables stopping (aborting) of the automatic
80 boot feature only by issuing a specific input key or
81 string. If not enabled, any input key will abort the
82 U-Boot automatic booting process and bring the device
83 to the U-Boot prompt for user input.
85 config AUTOBOOT_PROMPT
86 string "Autoboot stop prompt"
87 depends on AUTOBOOT_KEYED
88 default "Autoboot in %d seconds\\n"
90 This string is displayed before the boot delay selected by
91 CONFIG_BOOTDELAY starts. If it is not defined there is no
92 output indicating that autoboot is in progress.
94 Note that this define is used as the (only) argument to a
95 printf() call, so it may contain '%' format specifications,
96 provided that it also includes, sepearated by commas exactly
97 like in a printf statement, the required arguments. It is
98 the responsibility of the user to select only such arguments
99 that are valid in the given context.
101 config AUTOBOOT_ENCRYPTION
102 bool "Enable encryption in autoboot stopping"
103 depends on AUTOBOOT_KEYED
106 config AUTOBOOT_DELAY_STR
107 string "Delay autobooting via specific input key / string"
108 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
110 This option delays the automatic boot feature by issuing
111 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
112 or the environment variable "bootdelaykey" is specified
113 and this string is received from console input before
114 autoboot starts booting, U-Boot gives a command prompt. The
115 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
116 used, otherwise it never times out.
118 config AUTOBOOT_STOP_STR
119 string "Stop autobooting via specific input key / string"
120 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
122 This option enables stopping (aborting) of the automatic
123 boot feature only by issuing a specific input key or
124 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
125 variable "bootstopkey" is specified and this string is
126 received from console input before autoboot starts booting,
127 U-Boot gives a command prompt. The U-Boot prompt never
128 times out, even if CONFIG_BOOT_RETRY_TIME is used.
130 config AUTOBOOT_KEYED_CTRLC
131 bool "Enable Ctrl-C autoboot interruption"
132 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
135 This option allows for the boot sequence to be interrupted
136 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
137 Setting this variable provides an escape sequence from the
138 limited "password" strings.
140 config AUTOBOOT_STOP_STR_SHA256
141 string "Stop autobooting via SHA256 encrypted password"
142 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
144 This option adds the feature to only stop the autobooting,
145 and therefore boot into the U-Boot prompt, when the input
146 string / password matches a values that is encypted via
147 a SHA256 hash and saved in the environment.
169 Print ".config" contents.
171 If this option is enabled, the ".config" file contents are embedded
172 in the U-Boot image and can be printed on the console by the "config"
173 command. This provides information of which options are enabled on
180 Print console devices and information.
185 Print information about available CPUs. This normally shows the
186 number of CPUs, type (e.g. manufacturer, architecture, product or
187 internal name) and clock frequency. Other information may be
188 available depending on the CPU driver.
194 Print GPL license text
210 Run the command stored in the environment "bootcmd", i.e.
211 "bootd" does the same thing as "run bootcmd".
217 Boot an application image from the memory.
222 Boot the Linux zImage
226 depends on ARM64 || RISCV
229 Boot an AArch64 Linux Kernel image from memory.
233 depends on EFI_LOADER
236 Boot an EFI image from memory.
238 config CMD_BOOTEFI_HELLO_COMPILE
239 bool "Compile a standard EFI hello world binary for testing"
240 depends on CMD_BOOTEFI && !CPU_V7M && !SANDBOX
243 This compiles a standard EFI hello world application with U-Boot so
244 that it can be used with the test/py testing framework. This is useful
245 for testing that EFI is working at a basic level, and for bringing
246 up EFI support on a new architecture.
248 No additional space will be required in the resulting U-Boot binary
249 when this option is enabled.
251 config CMD_BOOTEFI_HELLO
252 bool "Allow booting a standard EFI hello world for testing"
253 depends on CMD_BOOTEFI_HELLO_COMPILE
255 This adds a standard EFI hello world application to U-Boot so that
256 it can be used with the 'bootefi hello' command. This is useful
257 for testing that EFI is working at a basic level, and for bringing
258 up EFI support on a new architecture.
260 source lib/efi_selftest/Kconfig
266 Add an ANSI terminal boot menu command.
271 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
272 image into RAM, dump image structure information, etc. Those dtb/dtbo
273 files should be merged in one dtb further, which needs to be passed to
274 the kernel, as part of a boot process.
277 bool "bootelf, bootvx"
280 Boot an ELF/vxWorks image from the memory.
283 bool "Flattened Device Tree utility commands"
287 Do FDT related setup before booting into the Operating System.
293 Start an application at a given address.
299 Run the command in the given environment variable.
305 Print header information for application image.
310 List all images found in flash
316 Extract a part of a multi-image.
319 bool "spl export - Export boot information for Falcon boot"
322 Falcon mode allows booting directly from SPL into an Operating
323 System such as Linux, thus skipping U-Boot proper. See
324 doc/README.falcon for full information about how to use this
327 config CMD_SPL_NAND_OFS
328 hex "Offset of OS command line args for Falcon-mode NAND boot"
332 This provides the offset of the command line arguments for Linux
333 when booting from NAND in Falcon mode. See doc/README.falcon
334 for full information about how to use this option (and also see
335 board/gateworks/gw_ventana/README for an example).
337 config CMD_SPL_WRITE_SIZE
338 hex "Size of argument area"
342 This provides the size of the command-line argument area in NAND
343 flash used by Falcon-mode boot. See the documentation until CMD_SPL
347 bool "fitImage update command"
349 Implements the 'fitupd' command, which allows to automatically
350 store software updates present on a TFTP server in NOR Flash
352 config CMD_THOR_DOWNLOAD
353 bool "thor - TIZEN 'thor' download"
355 Implements the 'thor' download protocol. This is a way of
356 downloading a software update over USB from an attached host.
357 There is no documentation about this within the U-Boot source code
358 but you should be able to find something on the interwebs.
361 bool "zboot - x86 boot command"
363 With x86 machines it is common to boot a bzImage file which
364 contains both a kernel and a setup.bin file. The latter includes
365 configuration information from the dark ages which x86 boards still
366 need to pick things out of.
368 Consider using FIT in preference to this since it supports directly
369 booting both 32- and 64-bit kernels, as well as secure boot.
370 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
374 menu "Environment commands"
377 bool "ask for env variable"
379 Ask for environment variable
397 Edit environment variable.
402 Allow for searching environment variables
408 Save all environment variables into the compiled-in persistent
411 config CMD_ENV_EXISTS
415 Check if a variable is defined in the environment for use in
418 config CMD_ENV_CALLBACK
419 bool "env callbacks - print callbacks and their associated variables"
421 Some environment variable have callbacks defined by
422 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
423 For example changing "baudrate" adjust the serial baud rate. This
424 command lists the currently defined callbacks.
427 bool "env flags -print variables that have non-default flags"
429 Some environment variables have special flags that control their
430 behaviour. For example, serial# can only be written once and cannot
431 be deleted. This command shows the variables that have special
434 config CMD_NVEDIT_EFI
435 bool "env [set|print] -e - set/print UEFI variables"
436 depends on EFI_LOADER
440 UEFI variables are encoded as some form of U-Boot variables.
441 If enabled, we are allowed to set/print UEFI variables using
442 "env" command with "-e" option without knowing details.
446 menu "Memory commands"
451 Compute binary operations (xor, or, and) of byte arrays of arbitrary
452 size from memory and store the result in memory or the environment.
465 Add -v option to verify data against a crc32 checksum.
468 bool "eeprom - EEPROM subsystem"
470 (deprecated, needs conversion to driver model)
471 Provides commands to read and write EEPROM (Electrically Erasable
472 Programmable Read Only Memory) chips that are connected over an
475 config CMD_EEPROM_LAYOUT
476 bool "Enable layout-aware eeprom commands"
477 depends on CMD_EEPROM
479 (deprecated, needs conversion to driver model)
480 When enabled, additional eeprom sub-commands become available.
482 eeprom print - prints the contents of the eeprom in a human-readable
483 way (eeprom layout fields, and data formatted to be fit for human
486 eeprom update - allows user to update eeprom fields by specifying
487 the field name, and providing the new data in a human readable format
488 (same format as displayed by the eeprom print command).
490 Both commands can either auto detect the layout, or be told which
494 __weak int parse_layout_version(char *str)
495 - override to provide your own layout name parsing
496 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
498 - override to setup the layout metadata based on the version
499 __weak int eeprom_layout_detect(unsigned char *data)
500 - override to provide your own algorithm for detecting layout
503 - contains various printing and updating functions for common
504 types of eeprom fields. Can be used for defining
507 config EEPROM_LAYOUT_HELP_STRING
508 string "Tells user what layout names are supported"
509 depends on CMD_EEPROM_LAYOUT
510 default "<not defined>"
512 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
518 Infinite write loop on address range
525 Compute MD5 checksum.
530 depends on CMD_MD5SUM
532 Add -v option to verify data against an MD5 checksum.
537 Display memory information.
540 bool "md, mm, nm, mw, cp, cmp, base, loop"
545 mm - memory modify (auto-incrementing address)
546 nm - memory modify (constant address)
547 mw - memory write (fill)
550 base - print or set address offset
551 loop - initialize loop on address range
556 Simple RAM read/write test.
560 config SYS_ALT_MEMTEST
561 bool "Alternative test"
563 Use a more complete alternative memory test.
570 mdc - memory display cyclic
571 mwc - memory write cyclic
577 Compute SHA1 checksum.
579 config SHA1SUM_VERIFY
581 depends on CMD_SHA1SUM
583 Add -v option to verify data against a SHA1 checksum.
586 bool "strings - display strings in memory"
588 This works similarly to the Unix 'strings' command except that it
589 works with a memory range. String of printable characters found
590 within the range are displayed. The minimum number of characters
591 for a sequence to be considered a string can be provided.
595 menu "Compression commands"
599 default y if CMD_BOOTI
602 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
607 default y if CMD_BOOTI
609 Uncompress a zip-compressed memory region.
614 Compress a memory region with zlib deflate method.
618 menu "Device access commands"
621 #depends on FLASH_CFI_DRIVER
624 ARM Ltd reference designs flash partition access
627 bool "adc - Access Analog to Digital Converters info and data"
631 Shows ADC device info and permit printing one-shot analog converted
632 data from a named Analog to Digital Converter.
635 bool "bind/unbind - Bind or unbind a device to/from a driver"
638 Bind or unbind a device to/from a driver from the command line.
639 This is useful in situations where a device may be handled by several
640 drivers. For example, this can be used to bind a UDC to the usb ether
641 gadget driver from the command line.
644 bool "clk - Show clock frequencies"
647 Shows clock frequences by calling a sock_clk_dump() hook function.
648 This is depreated in favour of using the CLK uclass and accessing
649 clock values from associated drivers. However currently no command
653 bool "demo - Demonstration commands for driver model"
656 Provides a 'demo' command which can be used to play around with
657 driver model. To use this properly you will need to enable one or
658 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
659 Otherwise you will always get an empty list of devices. The demo
660 devices are defined in the sandbox device tree, so the easiest
661 option is to use sandbox and pass the -d point to sandbox's
668 Enables the command "dfu" which is used to have U-Boot create a DFU
669 class device via USB. This command requires that the "dfu_alt_info"
670 environment variable be set and define the alt settings to expose to
674 bool "dm - Access to driver model information"
677 Provides access to driver model data structures and information,
678 such as a list of devices, list of uclasses and the state of each
679 device (e.g. activated). This is not required for operation, but
680 can be useful to see the state of driver model for debugging or
684 bool "fastboot - Android fastboot support"
687 This enables the command "fastboot" which enables the Android
688 fastboot mode for the platform. Fastboot is a protocol for
689 downloading images, flashing and device control used on
690 Android devices. Fastboot requires either the network stack
691 enabled or support for acting as a USB device.
693 See doc/README.android-fastboot for more information.
696 bool "fdcboot - Boot from floppy device"
698 The 'fdtboot' command allows booting an image from a floppy disk.
701 bool "flinfo, erase, protect"
705 flinfo - print FLASH memory information
707 protect - enable or disable FLASH write protection
716 config CMD_FPGA_LOADBP
717 bool "fpga loadbp - load partial bitstream (Xilinx only)"
720 Supports loading an FPGA device from a bitstream buffer containing
723 config CMD_FPGA_LOADFS
724 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
727 Supports loading an FPGA device from a FAT filesystem.
729 config CMD_FPGA_LOADMK
730 bool "fpga loadmk - load bitstream from image"
733 Supports loading an FPGA device from a image generated by mkimage.
735 config CMD_FPGA_LOADP
736 bool "fpga loadp - load partial bitstream"
739 Supports loading an FPGA device from a bitstream buffer containing
742 config CMD_FPGA_LOAD_SECURE
743 bool "fpga loads - loads secure bitstreams (Xilinx only)"
746 Enables the fpga loads command which is used to load secure
747 (authenticated or encrypted or both) bitstreams on to FPGA.
750 bool "fpgad - dump FPGA registers"
752 (legacy, needs conversion to driver model)
753 Provides a way to dump FPGA registers by calling the board-specific
754 fpga_get_reg() function. This functions similarly to the 'md'
758 bool "fuse - support for the fuse subssystem"
760 (deprecated - needs conversion to driver model)
761 This allows reading, sensing, programming or overriding fuses
762 which control the behaviour of the device. The command uses the
771 bool "GPT (GUID Partition Table) command"
773 select HAVE_BLOCK_DEVICE
774 select PARTITION_UUIDS
777 Enable the 'gpt' command to ready and write GPT style partition
781 bool "GPT Random UUID generation"
784 Enable the generation of partitions with random UUIDs if none
787 config CMD_GPT_RENAME
788 bool "GPT partition renaming commands"
791 Enables the 'gpt' command to interchange names on two GPT
792 partitions via the 'gpt swap' command or to rename single
793 partitions via the 'rename' command.
796 bool "ide - Support for IDE drivers"
799 Provides an 'ide' command which allows accessing the IDE drive,
800 reseting the IDE interface, printing the partition table and
801 geting device info. It also enables the 'diskboot' command which
802 permits booting from an IDE drive.
805 bool "io - Support for performing I/O accesses"
807 Provides an 'iod' command to display I/O space and an 'iow' command
808 to write values to the I/O space. This can be useful for manually
809 checking the state of devices during boot when debugging device
813 bool "iotrace - Support for tracing I/O activity"
815 Provides an 'iotrace' command which supports recording I/O reads and
816 writes in a trace buffer in memory . It also maintains a checksum
817 of the trace records (even if space is exhausted) so that the
818 sequence of I/O accesses can be verified.
820 When debugging drivers it is useful to see what I/O accesses were
821 done and in what order.
823 Even if the individual accesses are of little interest it can be
824 useful to verify that the access pattern is consistent each time
825 an operation is performed. In this case a checksum can be used to
826 characterise the operation of a driver. The checksum can be compared
827 across different runs of the operation to verify that the driver is
830 In particular, when performing major refactoring of the driver, where
831 the access pattern should not change, the checksum provides assurance
832 that the refactoring work has not broken the driver.
834 This works by sneaking into the io.h heder for an architecture and
835 redirecting I/O accesses through iotrace's tracing mechanism.
837 For now no commands are provided to examine the trace buffer. The
838 format is fairly simple, so 'md' is a reasonable substitute.
840 Note: The checksum feature is only useful for I/O regions where the
841 contents do not change outside of software control. Where this is not
842 suitable you can fall back to manually comparing the addresses. It
843 might be useful to enhance tracing to only checksum the accesses and
844 not the data read/written.
854 bool "w1 - Support for Dallas 1-Wire protocol"
856 Dallas 1-wire protocol support
862 Load a binary file over serial line.
868 Load an S-Record file over serial line
873 MMC memory mapped support.
876 bool "Enable support for RPMB in the mmc command"
879 Enable the commands for reading, writing and programming the
880 key for the Replay Protection Memory Block partition in eMMC.
882 config CMD_MMC_SWRITE
884 depends on CMD_MMC && MMC_WRITE
887 Enable support for the "mmc swrite" command to write Android sparse
892 select MTD_PARTITIONS
894 MTD commands support.
898 default y if NAND_SUNXI
903 config CMD_NAND_TRIMFFS
904 bool "nand write.trimffs"
905 default y if ARCH_SUNXI
907 Allows one to skip empty pages when flashing something on a NAND.
909 config CMD_NAND_LOCK_UNLOCK
910 bool "nand lock/unlock"
912 NAND locking support.
914 config CMD_NAND_TORTURE
917 NAND torture support.
926 NVM Express device support
929 bool "mmc_spi - Set up MMC SPI device"
931 Provides a way to set up an MMC (Multimedia Card) SPI (Serial
932 Peripheral Interface) device. The device provides a means of
933 accessing an MMC device via SPI using a single data line, limited
934 to 20MHz. It is useful since it reduces the amount of protocol code
938 bool "onenand - access to onenand device"
940 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
941 various useful features. This command allows reading, writing,
942 and erasing blocks. It allso provides a way to show and change
943 bad blocks, and test the device.
948 Enable the 'osd' command which allows to query information from and
949 write text data to a on-screen display (OSD) device; a virtual device
950 associated with a display capable of displaying a text overlay on the
951 display it's associated with..
955 select HAVE_BLOCK_DEVICE
956 select PARTITION_UUIDS
958 Read and display information about the partition table on
962 bool "pci - Access PCI devices"
964 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
965 used on some devices to allow the CPU to communicate with its
966 peripherals. Sub-commands allow bus enumeration, displaying and
967 changing configuration space and a few other features.
970 bool "pinit - Set up PCMCIA device"
972 Provides a means to initialise a PCMCIA (Personal Computer Memory
973 Card International Association) device. This is an old standard from
974 about 1990. These devices are typically removable memory or network
975 cards using a standard 68-pin connector.
978 bool "pinmux - show pins muxing"
981 Parse all available pin-controllers and show pins muxing. This
982 is useful for debug purpoer to check the pin muxing and to know if
983 a pin is configured as a GPIO or as an alternate function.
988 Poweroff/Shutdown the system
991 bool "read - Read binary data from a partition"
993 Provides low-level access to the data in a partition.
995 config CMD_REMOTEPROC
997 depends on REMOTEPROC
999 Support for Remote Processor control
1002 bool "sata - Access SATA subsystem"
1005 SATA (Serial Advanced Technology Attachment) is a serial bus
1006 standard for connecting to hard drives and other storage devices.
1007 This command provides information about attached devices and allows
1008 reading, writing and other operations.
1010 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1011 Attachment, where AT refers to an IBM AT (Advanced Technology)
1012 computer released in 1984.
1015 bool "saves - Save a file over serial in S-Record format"
1017 Provides a way to save a binary file using the Motorola S-Record
1018 format over the serial line.
1021 bool "scsi - Access to SCSI devices"
1024 This provides a 'scsi' command which provides access to SCSI (Small
1025 Computer System Interface) devices. The command provides a way to
1026 scan the bus, reset the bus, read and write data and get information
1030 bool "sdram - Print SDRAM configuration information"
1032 Provides information about attached SDRAM. This assumed that the
1033 SDRAM has an EEPROM with information that can be read using the
1034 I2C bus. This is only available on some boards.
1038 depends on DM_SPI_FLASH || SPI_FLASH
1043 bool "sf test - Allow testing of SPI flash"
1046 Provides a way to test that SPI flash is working correctly. The
1047 test is destructive, in that an area of SPI flash must be provided
1048 for the test to use. Performance information is also provided,
1049 measuring the performance of reading, writing and erasing in
1050 Mbps (Million Bits Per Second). This value should approximately
1051 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1052 everything is working properly.
1055 bool "sspi - Command to access spi device"
1058 SPI utility command.
1060 config DEFAULT_SPI_BUS
1061 int "default spi bus used by sspi command"
1065 config DEFAULT_SPI_MODE
1066 hex "default spi mode used by sspi command (see include/spi.h)"
1071 bool "tsi148 - Command to access tsi148 device"
1073 This provides various sub-commands to initialise and configure the
1074 Turndra tsi148 device. See the command help for full details.
1077 bool "universe - Command to set up the Turndra Universe controller"
1079 This allows setting up the VMEbus provided by this controller.
1080 See the command help for full details.
1084 select HAVE_BLOCK_DEVICE
1090 select USB_FUNCTION_SDP
1092 Enables the command "sdp" which is used to have U-Boot emulating the
1093 Serial Download Protocol (SDP) via USB.
1097 depends on USB_FUNCTION_ROCKUSB
1099 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1100 read/write info, image to/from devices. This enable rockusb command
1101 support to communication with rockusb device. for more detail about
1102 this command, please read doc/README.rockusb.
1104 config CMD_USB_MASS_STORAGE
1105 bool "UMS usb mass storage"
1106 select USB_FUNCTION_MASS_STORAGE
1108 USB mass storage support
1115 VirtIO block device support
1121 This provides commands to control the watchdog timer devices.
1127 Enable the command "axi" for accessing AXI (Advanced eXtensible
1128 Interface) busses, a on-chip interconnect specification for managing
1129 functional blocks in SoC designs, which is also often used in designs
1130 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1134 menu "Shell scripting commands"
1140 Echo args to console
1146 Return true/false on integer compare.
1152 Run script from memory
1158 Evaluate boolean and math expressions and store the result in an env
1160 Also supports loading the value at a memory location into a variable.
1161 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1168 bool "Network commands"
1178 bootp - boot image via network using BOOTP/TFTP protocol
1182 depends on CMD_BOOTP
1184 Boot image via network using DHCP/TFTP protocol
1186 config BOOTP_BOOTPATH
1187 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1189 depends on CMD_BOOTP
1191 Even though the config is called BOOTP_BOOTPATH, it stores the
1192 path in the variable 'rootpath'.
1195 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1197 depends on CMD_BOOTP
1199 The primary DNS server is stored as 'dnsip'. If two servers are
1200 returned, you must set BOOTP_DNS2 to store that second server IP
1204 bool "Store 'dnsip2' from BOOTP/DHCP server"
1205 depends on BOOTP_DNS
1207 If a DHCP client requests the DNS server IP from a DHCP server,
1208 it is possible that more than one DNS serverip is offered to the
1209 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1210 server IP will be stored in the additional environment
1211 variable "dnsip2". The first DNS serverip is always
1212 stored in the variable "dnsip", when BOOTP_DNS is defined.
1214 config BOOTP_GATEWAY
1215 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1217 depends on CMD_BOOTP
1219 config BOOTP_HOSTNAME
1220 bool "Request & store 'hostname' from BOOTP/DHCP server"
1222 depends on CMD_BOOTP
1224 The name may or may not be qualified with the local domain name.
1226 config BOOTP_PREFER_SERVERIP
1227 bool "serverip variable takes precedent over DHCP server IP."
1228 depends on CMD_BOOTP
1230 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1232 With this option enabled, the 'serverip' variable in the environment
1233 takes precedence over DHCP server IP and will only be set by the DHCP
1234 server if not already set in the environment.
1236 config BOOTP_SUBNETMASK
1237 bool "Request & store 'netmask' from BOOTP/DHCP server"
1239 depends on CMD_BOOTP
1241 config BOOTP_NTPSERVER
1242 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1243 depends on CMD_BOOTP
1246 bool "Send PXE client arch to BOOTP/DHCP server"
1248 depends on CMD_BOOTP && CMD_PXE
1250 Supported for ARM, ARM64, and x86 for now.
1252 config BOOTP_PXE_CLIENTARCH
1254 depends on BOOTP_PXE
1255 default 0x16 if ARM64
1259 config BOOTP_VCI_STRING
1261 depends on CMD_BOOTP
1262 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1263 default "U-Boot.armv8" if ARM64
1264 default "U-Boot.arm" if ARM
1271 tftpboot - boot image via network using TFTP protocol
1275 depends on CMD_TFTPBOOT
1277 TFTP put command, for uploading files to a server
1281 depends on CMD_TFTPBOOT
1283 Act as a TFTP server and boot the first received file
1285 config NET_TFTP_VARS
1286 bool "Control TFTP timeout and count through environment"
1287 depends on CMD_TFTPBOOT
1290 If set, allows controlling the TFTP timeout through the
1291 environment variable tftptimeout, and the TFTP maximum
1292 timeout count through the variable tftptimeoutcountmax.
1293 If unset, timeout and maximum are hard-defined as 1 second
1294 and 10 timouts per TFTP transfer.
1299 Boot image via network using RARP/TFTP protocol
1305 Boot image via network using NFS protocol.
1310 Enable MII utility commands.
1315 Send ICMP ECHO_REQUEST to network host
1320 Perform CDP network configuration
1325 Synchronize RTC via network
1330 Lookup the IP of a hostname
1332 config CMD_LINK_LOCAL
1336 Acquire a network IP address using the link-local protocol
1343 Allow control of L2 Ethernet switch commands. These are supported
1344 by the vsc9953 Ethernet driver at present. Sub-commands allow
1345 operations such as enabling / disabling a port and
1346 viewing/maintaining the filtering database (FDB)
1352 Boot image via network using PXE protocol
1357 Wait for wake-on-lan Magic Packet
1361 menu "Misc commands"
1364 bool "Enable 'bmp' command"
1365 depends on LCD || DM_VIDEO || VIDEO
1367 This provides a way to obtain information about a BMP-format iamge
1368 and to display it. BMP (which presumably stands for BitMaP) is a
1369 file format defined by Microsoft which supports images of various
1370 depths, formats and compression methods. Headers on the file
1371 determine the formats used. This command can be used by first loading
1372 the image into RAM, then using this command to look at it or display
1375 config CMD_BOOTCOUNT
1377 depends on BOOTCOUNT_LIMIT
1379 Enable the bootcount command, which allows interrogation and
1380 reset of the bootcounter.
1383 bool "Enable board-specific commands"
1385 (deprecated: instead, please define a Kconfig option for each command)
1387 Some boards have board-specific commands which are only enabled
1388 during developemnt and need to be turned off for production. This
1389 option provides a way to control this. The commands that are enabled
1390 vary depending on the board.
1392 config CMD_BKOPS_ENABLE
1393 bool "mmc bkops enable"
1397 Enable command for setting manual background operations handshake
1398 on a eMMC device. The feature is optionally available on eMMC devices
1399 conforming to standard >= 4.41.
1401 config CMD_BLOCK_CACHE
1402 bool "blkcache - control and stats for block cache"
1403 depends on BLOCK_CACHE
1404 default y if BLOCK_CACHE
1406 Enable the blkcache command, which can be used to control the
1407 operation of the cache functions.
1408 This is most useful when fine-tuning the operation of the cache
1409 during development, but also allows the cache to be disabled when
1410 it might hurt performance (e.g. when using the ums command).
1413 bool "icache or dcache"
1415 Enable the "icache" and "dcache" commands
1417 config CMD_CONITRACE
1418 bool "conitrace - trace console input codes"
1420 Enable the 'conitrace' command which displays the codes received
1421 from the console input as hexadecimal numbers.
1424 bool "Enable clear screen command 'cls'"
1425 depends on CFB_CONSOLE || DM_VIDEO || LCD || VIDEO
1428 Enable the 'cls' command which clears the screen contents
1429 on video frame buffer.
1432 bool "efidebug - display/configure UEFI environment"
1433 depends on EFI_LOADER
1434 select EFI_DEVICE_PATH_TO_TEXT
1437 Enable the 'efidebug' command which provides a subset of UEFI
1438 shell utility with simplified functionality. It will be useful
1439 particularly for managing boot parameters as well as examining
1440 various EFI status for debugging.
1442 config CMD_EXCEPTION
1443 bool "exception - raise exception"
1444 depends on ARM || RISCV || X86
1446 Enable the 'exception' command which allows to raise an exception.
1453 Enable the 'led' command which allows for control of LEDs supported
1454 by the board. The LEDs can be listed with 'led list' and controlled
1455 with led on/off/togle/blink. Any LED drivers can be controlled with
1456 this command, e.g. led_gpio.
1462 Enable the 'date' command for getting/setting the time/date in RTC
1468 Run commands and summarize execution time.
1471 bool "gettime - read elapsed time"
1473 Enable the 'gettime' command which reads the elapsed time since
1474 U-Boot started running. This shows the time in seconds and
1475 milliseconds. See also the 'bootstage' command which provides more
1476 flexibility for boot timing.
1478 # TODO: rename to CMD_SLEEP
1483 Delay execution for some time
1486 bool "support for multiprocessor"
1488 This provides an option to brinup
1489 different processors in multiprocessor
1495 Access the system timer.
1501 This provides basic access to the U-Boot's sound support. The main
1502 feature is to play a beep.
1504 sound init - set up sound system
1505 sound play - play a sound
1511 This provides access to the QEMU firmware interface. The main
1512 feature is to allow easy loading of files passed to qemu-system
1513 via -kernel / -initrd
1515 source "cmd/mvebu/Kconfig"
1518 bool "terminal - provides a way to attach a serial terminal"
1520 Provides a 'cu'-like serial terminal command. This can be used to
1521 access other serial ports from the system console. The terminal
1522 is very simple with no special processing of characters. As with
1523 cu, you can press ~. (tilde followed by period) to exit.
1526 bool "uuid, guid - generation of unique IDs"
1529 This enables two commands:
1531 uuid - generate random Universally Unique Identifier
1532 guid - generate Globally Unique Identifier based on random UUID
1534 The two commands are very similar except for the endianness of the
1539 source "cmd/ti/Kconfig"
1541 config CMD_BOOTSTAGE
1542 bool "Enable the 'bootstage' command"
1543 depends on BOOTSTAGE
1545 Add a 'bootstage' command which supports printing a report
1546 and un/stashing of bootstage data.
1548 menu "Power commands"
1550 bool "Enable Driver Model PMIC command"
1553 This is the pmic command, based on a driver model pmic's API.
1554 Command features are unchanged:
1555 - list - list pmic devices
1556 - pmic dev <id> - show or [set] operating pmic device (NEW)
1557 - pmic dump - dump registers
1558 - pmic read address - read byte of register at address
1559 - pmic write address - write byte to register at address
1560 The only one change for this command is 'dev' subcommand.
1562 config CMD_REGULATOR
1563 bool "Enable Driver Model REGULATOR command"
1564 depends on DM_REGULATOR
1566 This command is based on driver model regulator's API.
1567 User interface features:
1568 - list - list regulator devices
1569 - regulator dev <id> - show or [set] operating regulator device
1570 - regulator info - print constraints info
1571 - regulator status - print operating status
1572 - regulator value <val] <-f> - print/[set] voltage value [uV]
1573 - regulator current <val> - print/[set] current value [uA]
1574 - regulator mode <id> - print/[set] operating mode id
1575 - regulator enable - enable the regulator output
1576 - regulator disable - disable the regulator output
1578 The '-f' (force) option can be used for set the value which exceeds
1579 the limits, which are found in device-tree and are kept in regulator's
1580 uclass platdata structure.
1584 menu "Security commands"
1586 bool "Enable the 'aes' command"
1589 This provides a means to encrypt and decrypt data using the AES
1590 (Advanced Encryption Standard). This algorithm uses a symetric key
1591 and is widely used as a streaming cipher. Different key lengths are
1592 supported by the algorithm but this command only supports 128 bits
1596 bool "Enable the 'blob' command"
1598 This is used with the Freescale secure boot mechanism.
1600 Freescale's SEC block has built-in Blob Protocol which provides
1601 a method for protecting user-defined data across system power
1602 cycles. SEC block protects data in a data structure called a Blob,
1603 which provides both confidentiality and integrity protection.
1605 Encapsulating data as a blob
1606 Each time that the Blob Protocol is used to protect data, a
1607 different randomly generated key is used to encrypt the data.
1608 This random key is itself encrypted using a key which is derived
1609 from SoC's non-volatile secret key and a 16 bit Key identifier.
1610 The resulting encrypted key along with encrypted data is called a
1611 blob. The non-volatile secure key is available for use only during
1614 During decapsulation, the reverse process is performed to get back
1618 blob enc - encapsulating data as a cryptgraphic blob
1619 blob dec - decapsulating cryptgraphic blob to get the data
1623 blob enc src dst len km
1625 Encapsulate and create blob of data $len bytes long
1626 at address $src and store the result at address $dst.
1627 $km is the 16 byte key modifier is also required for
1628 generation/use as key for cryptographic operation. Key
1629 modifier should be 16 byte long.
1631 blob dec src dst len km
1633 Decapsulate the blob of data at address $src and
1634 store result of $len byte at addr $dst.
1635 $km is the 16 byte key modifier is also required for
1636 generation/use as key for cryptographic operation. Key
1637 modifier should be 16 byte long.
1640 bool "Support 'hash' command"
1643 This provides a way to hash data in memory using various supported
1644 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1645 saved to memory or to an environment variable. It is also possible
1646 to verify a hash against data in memory.
1649 bool "Support the 'hvc' command"
1650 depends on ARM_SMCCC
1652 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
1653 development and testing.
1656 bool "Support the 'smc' command"
1657 depends on ARM_SMCCC
1659 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
1660 development and testing.
1666 Add -v option to verify data against a hash.
1676 bool "Enable the 'tpm' command"
1677 depends on TPM_V1 || TPM_V2
1678 select CMD_TPM_V1 if TPM_V1
1679 select CMD_TPM_V2 if TPM_V2
1681 This provides a means to talk to a TPM from the command line. A wide
1682 range of commands if provided - see 'tpm help' for details. The
1683 command requires a suitable TPM on your board and the correct driver
1689 bool "Enable the 'tpm test' command"
1692 This provides a a series of tests to confirm that the TPMv1.x is
1693 working correctly. The tests cover initialisation, non-volatile RAM,
1694 extend, global lock and checking that timing is within expectations.
1695 The tests pass correctly on Infineon TPMs but may need to be adjusted
1702 menu "Firmware commands"
1704 bool "Enable crosec command"
1708 Enable command-line access to the Chrome OS EC (Embedded
1709 Controller). This provides the 'crosec' command which has
1710 a number of sub-commands for performing EC tasks such as
1711 updating its flash, accessing a small saved context area
1712 and talking to the I2C bus behind the EC (if there is one).
1715 menu "Filesystem commands"
1717 bool "Enable the 'btrsubvol' command"
1720 This enables the 'btrsubvol' command to list subvolumes
1721 of a BTRFS filesystem. There are no special commands for
1722 listing BTRFS directories or loading BTRFS files - this
1723 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
1724 when BTRFS is enabled (see FS_BTRFS).
1727 bool "Enable the 'cbfs' command"
1730 Define this to enable support for reading from a Coreboot
1731 filesystem. This is a ROM-based filesystem used for accessing files
1732 on systems that use coreboot as the first boot-loader and then load
1733 U-Boot to actually boot the Operating System. Available commands are
1734 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1737 bool "Enable the 'cramfs' command"
1738 depends on FS_CRAMFS
1740 This provides commands for dealing with CRAMFS (Compressed ROM
1741 filesystem). CRAMFS is useful when space is tight since files are
1742 compressed. Two commands are provided:
1744 cramfsls - lists files in a cramfs image
1745 cramfsload - loads a file from a cramfs image
1748 bool "ext2 command support"
1751 Enables EXT2 FS command
1754 bool "ext4 command support"
1757 Enables EXT4 FS command
1759 config CMD_EXT4_WRITE
1761 bool "ext4 write command support"
1764 Enables EXT4 FS write command
1767 bool "FAT command support"
1770 Support for the FAT fs
1772 config CMD_FS_GENERIC
1773 bool "filesystem commands"
1775 Enables filesystem commands (e.g. load, ls) that work for multiple
1779 bool "fsuuid command"
1781 Enables fsuuid command for filesystem UUID.
1784 bool "jffs2 command"
1787 Enables commands to support the JFFS2 (Journalling Flash File System
1788 version 2) filesystem. This enables fsload, ls and fsinfo which
1789 provide the ability to load files, list directories and obtain
1790 filesystem information.
1793 bool "MTD partition support"
1794 select MTD_DEVICE if (CMD_NAND || NAND)
1796 MTD partitioning tool support.
1797 It is strongly encouraged to avoid using this command
1798 anymore along with 'sf', 'nand', 'onenand'. One can still
1799 declare the partitions in the mtdparts environment variable
1800 but better use the MTD stack and the 'mtd' command instead.
1802 config MTDIDS_DEFAULT
1803 string "Default MTD IDs"
1804 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1806 Defines a default MTD IDs list for use with MTD partitions in the
1807 Linux MTD command line partitions format.
1809 config MTDPARTS_DEFAULT
1810 string "Default MTD partition scheme"
1811 depends on MTD_PARTITIONS || CMD_MTDPARTS || CMD_NAND || CMD_FLASH
1813 Defines a default MTD partitioning scheme in the Linux MTD command
1814 line partitions format
1816 config CMD_MTDPARTS_SPREAD
1817 bool "Padd partition size to take account of bad blocks"
1818 depends on CMD_MTDPARTS
1820 This enables the 'spread' sub-command of the mtdparts command.
1821 This command will modify the existing mtdparts variable by increasing
1822 the size of the partitions such that 1) each partition's net size is
1823 at least as large as the size specified in the mtdparts variable and
1824 2) each partition starts on a good block.
1827 bool "reiser - Access to reiserfs filesystems"
1829 This provides two commands which operate on a resierfs filesystem,
1830 commonly used some years ago:
1832 reiserls - list files
1833 reiserload - load a file
1836 bool "yaffs2 - Access of YAFFS2 filesystem"
1840 This provides commands for accessing a YAFFS2 filesystem. Yet
1841 Another Flash Filesystem 2 is a filesystem designed specifically
1842 for NAND flash. It incorporates bad-block management and ensures
1843 that device writes are sequential regardless of filesystem
1847 bool "zfs - Access of ZFS filesystem"
1849 This provides commands to accessing a ZFS filesystem, commonly used
1850 on Solaris systems. Two sub-commands are provided:
1852 zfsls - list files in a directory
1853 zfsload - load a file
1855 See doc/README.zfs for more details.
1859 menu "Debug commands"
1864 The bedbug (emBEDded deBUGger) command provides debugging features
1865 for some PowerPC processors. For details please see the
1866 docuemntation in doc/README.beddbug
1869 bool "diag - Board diagnostics"
1871 This command provides access to board diagnostic tests. These are
1872 called Power-on Self Tests (POST). The command allows listing of
1873 available tests and running either all the tests, or specific tests
1877 bool "irq - Show information about interrupts"
1878 depends on !ARM && !MIPS && !SH
1880 This enables two commands:
1882 interrupts - enable or disable interrupts
1883 irqinfo - print device-specific interrupt information
1886 bool "kgdb - Allow debugging of U-Boot with gdb"
1889 This enables a 'kgdb' command which allows gdb to connect to U-Boot
1890 over a serial link for debugging purposes. This allows
1891 single-stepping, inspecting variables, etc. This is supported only
1892 on PowerPC at present.
1895 bool "log - Generation, control and access to logging"
1898 This provides access to logging features. It allows the output of
1899 log data to be controlled to a limited extent (setting up the default
1900 maximum log level for emitting of records). It also provides access
1901 to a command used for testing the log system.
1904 bool "trace - Support tracing of function calls and timing"
1906 Enables a command to control using of function tracing within
1907 U-Boot. This allows recording of call traces including timing
1908 information. The command can write data to memory for exporting
1909 for analysis (e.g. using bootchart). See doc/README.trace for full
1913 bool "avb - Android Verified Boot 2.0 operations"
1914 depends on AVB_VERIFY
1917 Enables a "avb" command to perform verification of partitions using
1918 Android Verified Boot 2.0 functionality. It includes such subcommands:
1919 avb init - initialize avb2 subsystem
1920 avb read_rb - read rollback index
1921 avb write_rb - write rollback index
1922 avb is_unlocked - check device lock state
1923 avb get_uuid - read and print uuid of a partition
1924 avb read_part - read data from partition
1925 avb read_part_hex - read data from partition and output to stdout
1926 avb write_part - write data to partition
1927 avb verify - run full verification chain
1931 tristate "Enable UBI - Unsorted block images commands"
1934 UBI is a software layer above MTD layer which admits use of LVM-like
1935 logical volumes on top of MTD devices, hides some complexities of
1936 flash chips like wear and bad blocks and provides some other useful
1937 capabilities. Please, consult the MTD web site for more details
1938 (www.linux-mtd.infradead.org). Activate this option if you want
1939 to use U-Boot UBI commands.
1940 It is also strongly encouraged to also enable CONFIG_MTD to get full
1944 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1946 default y if CMD_UBI
1949 UBIFS is a file system for flash devices which works on top of UBI.
projects / oweals / u-boot.git / blob