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
34 config CMDLINE_PS_SUPPORT
35 bool "Enable support for changing the command prompt string at run-time"
36 depends on HUSH_PARSER
38 Only static string in the prompt is supported so far. The string is
39 obtained from environment variables PS1 and PS2.
42 bool "Enable auto complete using TAB"
46 Enable auto completion of commands using TAB.
49 bool "Enable long help messages"
53 Defined when you want long help messages included
54 Do not set this option when short of memory.
58 default "Zynq> " if ARCH_ZYNQ
59 default "ZynqMP> " if ARCH_ZYNQMP
62 This string is displayed in the command line to the left of the
65 config SYS_PROMPT_HUSH_PS2
66 string "Hush shell secondary prompt"
67 depends on HUSH_PARSER
70 This defines the secondary prompt string, which is
71 printed when the command interpreter needs more input
72 to complete a command. Usually "> ".
75 int "Maximum number arguments accepted by commands"
79 int "Console input buffer size"
80 default 2048 if ARCH_TEGRA || ARCH_VERSAL || ARCH_ZYNQ || ARCH_ZYNQMP || \
81 RCAR_GEN3 || TARGET_SOCFPGA_SOC64
82 default 512 if ARCH_MX5 || ARCH_MX6 || ARCH_MX7 || FSL_LSCH2 || \
84 default 256 if M68K || PPC
88 int "Buffer size for console output"
89 default 1024 if ARCH_SUNXI
93 bool "Command execution tracer"
97 This option enables the possiblity to print all commands before
98 executing them and after all variables are evaluated (similar
99 to Bash's xtrace/'set -x' feature).
100 To enable the tracer a variable "xtrace" needs to be defined in
115 List and dump ACPI tables. ACPI (Advanced Configuration and Power
116 Interface) is used mostly on x86 for providing information to the
117 Operating System about devices in the system. The tables are set up
118 by the firmware, typically U-Boot but possibly an earlier firmware
119 module, if U-Boot is chain-loaded from something else. ACPI tables
120 can also include code, to perform hardware-specific tasks required
121 by the Operating Systems. This allows some amount of separation
122 between the firmware and OS, and is particularly useful when you
123 want to make hardware changes without the OS needing to be adjusted.
130 List non-identity virtual-physical memory mappings for 32-bit CPUs.
143 Print ".config" contents.
145 If this option is enabled, the ".config" file contents are embedded
146 in the U-Boot image and can be printed on the console by the "config"
147 command. This provides information of which options are enabled on
154 Print console devices and information.
160 Print information about available CPUs. This normally shows the
161 number of CPUs, type (e.g. manufacturer, architecture, product or
162 internal name) and clock frequency. Other information may be
163 available depending on the CPU driver.
165 config CMD_FWU_METADATA
166 bool "fwu metadata read"
167 depends on FWU_MULTI_BANK_UPDATE
169 Command to read the metadata and dump it's contents
175 Print GPL license text
180 Provides access to the Intel Power-Management Controller (PMC) so
181 that its state can be examined. This does not currently support
182 changing the state but it is still useful for debugging and seeing
191 config CMD_TLV_EEPROM
193 depends on I2C_EEPROM
196 Display and program the system EEPROM data block in ONIE Tlvinfo
197 format. TLV stands for Type-Length-Value.
199 config SPL_CMD_TLV_EEPROM
200 bool "tlv_eeprom for SPL"
201 depends on SPL_I2C_EEPROM
202 select SPL_DRIVERS_MISC
205 Read system EEPROM data block in ONIE Tlvinfo format from SPL.
209 depends on RISCV_SMODE && SBI_V02
211 Display information about the SBI implementation.
221 Run the command stored in the environment "bootcmd", i.e.
222 "bootd" does the same thing as "run bootcmd".
228 Boot an application image from the memory.
230 config CMD_BOOTM_PRE_LOAD
231 bool "enable pre-load on bootm"
233 depends on IMAGE_PRE_LOAD
236 Enable support of stage pre-load for the bootm command.
237 This stage allow to check or modify the image provided
238 to the bootm command.
243 default y if BOOTSTD_FULL
245 Support listing available bootdevs (boot devices) which can provide an
246 OS to boot, as well as showing information about a particular one.
248 This command is not necessary for bootstd to work.
255 Support scanning for bootflows available with the bootdevs. The
256 bootflows can optionally be booted.
258 config CMD_BOOTFLOW_FULL
259 bool "bootflow - extract subcommands"
260 depends on BOOTSTD_FULL
261 default y if BOOTSTD_FULL
263 Add the ability to list the available bootflows, select one and obtain
264 information about it.
266 This command is not necessary for bootstd to work.
271 default y if BOOTSTD_FULL
273 Support listing available bootmethds (methods used to boot an
274 Operating System), as well as selecting the order that the bootmeths
277 This command is not necessary for bootstd to work.
280 bool "Support booting UEFI FIT images"
281 depends on CMD_BOOTEFI && CMD_BOOTM && FIT
284 Support booting UEFI FIT images via the bootm command.
289 Boot the Linux zImage
293 depends on ARM64 || RISCV
296 Boot an AArch64 Linux Kernel image from memory.
299 bool "Support booting Linux OS images"
300 depends on CMD_BOOTM || CMD_BOOTZ || CMD_BOOTI
303 Support booting the Linux kernel directly via a command such as bootm
307 bool "Support booting NetBSD (non-EFI) loader images"
311 Support booting NetBSD via the bootm command.
313 config BOOTM_OPENRTOS
314 bool "Support booting OPENRTOS / FreeRTOS images"
317 Support booting OPENRTOS / FreeRTOS via the bootm command.
320 bool "Support booting Enea OSE images"
321 depends on (ARM && (ARM64 || CPU_V7A || CPU_V7R) || SANDBOX || PPC || X86)
324 Support booting Enea OSE images via the bootm command.
327 bool "Support booting Plan9 OS images"
331 Support booting Plan9 images via the bootm command.
334 bool "Support booting RTEMS OS images"
338 Support booting RTEMS images via the bootm command.
341 bool "vbe - Verified Boot for Embedded"
342 depends on BOOTMETH_VBE
343 default y if BOOTSTD_FULL
345 Provides various subcommands related to VBE, such as listing the
346 available methods, looking at the state and changing which method
347 is used to boot. Updating the parameters is not currently
351 bool "Support booting VxWorks OS images"
355 Support booting VxWorks images via the bootm command.
358 hex "Maximum size of a decompresed OS image"
359 depends on CMD_BOOTM || CMD_BOOTI || CMD_BOOTZ
360 default 0x4000000 if PPC || ARM64
361 default 0x1000000 if X86 || ARCH_MX6 || ARCH_MX7
364 This is the maximum size of the buffer that is used to decompress the OS
365 image in to, if passing a compressed image to bootm/booti/bootz.
369 depends on EFI_LOADER
372 Boot an EFI image from memory.
374 config CMD_BOOTEFI_HELLO_COMPILE
375 bool "Compile a standard EFI hello world binary for testing"
376 depends on CMD_BOOTEFI && !CPU_V7M
379 This compiles a standard EFI hello world application with U-Boot so
380 that it can be used with the test/py testing framework. This is useful
381 for testing that EFI is working at a basic level, and for bringing
382 up EFI support on a new architecture.
384 No additional space will be required in the resulting U-Boot binary
385 when this option is enabled.
387 config CMD_BOOTEFI_HELLO
388 bool "Allow booting a standard EFI hello world for testing"
389 depends on CMD_BOOTEFI_HELLO_COMPILE
390 default y if CMD_BOOTEFI_SELFTEST
392 This adds a standard EFI hello world application to U-Boot so that
393 it can be used with the 'bootefi hello' command. This is useful
394 for testing that EFI is working at a basic level, and for bringing
395 up EFI support on a new architecture.
397 source lib/efi_selftest/Kconfig
404 Add an ANSI terminal boot menu command.
409 Android DTB/DTBO image manipulation commands. Read dtb/dtbo files from
410 image into RAM, dump image structure information, etc. Those dtb/dtbo
411 files should be merged in one dtb further, which needs to be passed to
412 the kernel, as part of a boot process.
416 depends on ANDROID_BOOT_IMAGE
418 Android Boot Image manipulation commands. Allows one to extract
419 images contained in boot.img, like kernel, ramdisk, dtb, etc, and
420 obtain corresponding meta-information from boot.img.
422 See doc/android/boot-image.rst for details.
425 bool "bootelf, bootvx"
429 Boot an ELF/vxWorks image from the memory.
432 bool "Flattened Device Tree utility commands"
436 Do FDT related setup before booting into the Operating System.
438 config SUPPORT_EXTENSION_SCAN
442 bool "Extension board management command"
444 depends on SUPPORT_EXTENSION_SCAN
446 Enables the "extension" command, which allows to detect
447 extension boards connected to the system, and apply
448 corresponding Device Tree overlays.
454 Start an application at a given address.
460 Run the command in the given environment variable.
466 Print header information for application image.
471 List all images found in flash
477 Extract a part of a multi-image.
482 Print file as hexdump to standard output
485 bool "spl export - Export boot information for Falcon boot"
488 Falcon mode allows booting directly from SPL into an Operating
489 System such as Linux, thus skipping U-Boot proper. See
490 doc/README.falcon for full information about how to use this
493 config CMD_SPL_NAND_OFS
494 hex "Offset of OS args or dtb for Falcon-mode NAND boot"
495 depends on CMD_SPL && (TPL_NAND_SUPPORT || SPL_NAND_SUPPORT)
498 This provides the offset of the command line arguments for Linux
499 when booting from NAND in Falcon mode. See doc/README.falcon
500 for full information about how to use this option (and also see
501 board/gateworks/gw_ventana/README for an example).
503 config CMD_SPL_NOR_OFS
504 hex "Offset of OS args or dtb for Falcon-mode NOR boot"
505 depends on CMD_SPL && SPL_NOR_SUPPORT
508 This provides the offset of the command line arguments or dtb for
509 Linux when booting from NOR in Falcon mode.
511 config CMD_SPL_WRITE_SIZE
512 hex "Size of argument area"
516 This provides the size of the command-line argument area in NAND
517 flash used by Falcon-mode boot. See the documentation until CMD_SPL
520 config CMD_THOR_DOWNLOAD
521 bool "thor - TIZEN 'thor' download"
524 Implements the 'thor' download protocol. This is a way of
525 downloading a software update over USB from an attached host.
526 There is no documentation about this within the U-Boot source code
527 but you should be able to find something on the interwebs.
530 bool "zboot - x86 boot command"
532 With x86 machines it is common to boot a bzImage file which
533 contains both a kernel and a setup.bin file. The latter includes
534 configuration information from the dark ages which x86 boards still
535 need to pick things out of.
537 Consider using FIT in preference to this since it supports directly
538 booting both 32- and 64-bit kernels, as well as secure boot.
539 Documentation is available in doc/uImage.FIT/x86-fit-boot.txt
543 menu "Environment commands"
546 bool "ask for env variable"
548 Ask for environment variable
566 Edit environment variable.
571 Allow for searching environment variables
577 Save all environment variables into the compiled-in persistent
582 depends on CMD_SAVEENV
584 Erase environment variables from the compiled-in persistent
587 config CMD_ENV_EXISTS
591 Check if a variable is defined in the environment for use in
594 config CMD_ENV_CALLBACK
595 bool "env callbacks - print callbacks and their associated variables"
597 Some environment variable have callbacks defined by
598 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
599 For example changing "baudrate" adjust the serial baud rate. This
600 command lists the currently defined callbacks.
603 bool "env flags -print variables that have non-default flags"
605 Some environment variables have special flags that control their
606 behaviour. For example, serial# can only be written once and cannot
607 be deleted. This command shows the variables that have special
610 config CMD_NVEDIT_EFI
611 bool "env [set|print] -e - set/print UEFI variables"
612 depends on EFI_LOADER
615 UEFI variables are encoded as some form of U-Boot variables.
616 If enabled, we are allowed to set/print UEFI variables using
617 "env" command with "-e" option without knowing details.
619 config CMD_NVEDIT_INDIRECT
620 bool "env indirect - Sets environment value from another"
622 config CMD_NVEDIT_INFO
623 bool "env info - print or evaluate environment information"
625 Print environment information:
626 - env_valid : is environment valid
627 - env_ready : is environment imported into hash table
628 - env_use_default : is default environment used
630 This command can be optionally used for evaluation in scripts:
631 [-d] : evaluate whether default environment is used
632 [-p] : evaluate whether environment can be persisted
634 The result of multiple evaluations will be combined with AND.
636 config CMD_NVEDIT_LOAD
639 Load all environment variables from the compiled-in persistent
642 config CMD_NVEDIT_SELECT
645 Select the compiled-in persistent storage of environment variables.
649 menu "Memory commands"
654 Compute binary operations (xor, or, and) of byte arrays of arbitrary
655 size from memory and store the result in memory or the environment.
659 default y if BLOBLIST
661 Show information about the bloblist, a collection of binary blobs
662 held in memory that persist between SPL and U-Boot. In the case of
663 x86 devices the bloblist can be used to hold ACPI tables so that they
664 remain available in memory.
677 Add -v option to verify data against a crc32 checksum.
680 bool "eeprom - EEPROM subsystem"
682 (deprecated, needs conversion to driver model)
683 Provides commands to read and write EEPROM (Electrically Erasable
684 Programmable Read Only Memory) chips that are connected over an
687 config CMD_EEPROM_LAYOUT
688 bool "Enable layout-aware eeprom commands"
689 depends on CMD_EEPROM
691 (deprecated, needs conversion to driver model)
692 When enabled, additional eeprom sub-commands become available.
694 eeprom print - prints the contents of the eeprom in a human-readable
695 way (eeprom layout fields, and data formatted to be fit for human
698 eeprom update - allows user to update eeprom fields by specifying
699 the field name, and providing the new data in a human readable format
700 (same format as displayed by the eeprom print command).
702 Both commands can either auto detect the layout, or be told which
706 __weak int parse_layout_version(char *str)
707 - override to provide your own layout name parsing
708 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
710 - override to setup the layout metadata based on the version
711 __weak int eeprom_layout_detect(unsigned char *data)
712 - override to provide your own algorithm for detecting layout
715 - contains various printing and updating functions for common
716 types of eeprom fields. Can be used for defining
719 config EEPROM_LAYOUT_HELP_STRING
720 string "Tells user what layout names are supported"
721 depends on CMD_EEPROM_LAYOUT
722 default "<not defined>"
724 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
727 config SYS_I2C_EEPROM_BUS
728 int "I2C bus of the EEPROM device."
729 depends on CMD_EEPROM
732 config SYS_I2C_EEPROM_ADDR_LEN
733 int "Length in bytes of the EEPROM memory array address"
734 depends on CMD_EEPROM || ID_EEPROM
738 Note: This is NOT the chip address length!
740 config SYS_EEPROM_SIZE
741 depends on CMD_EEPROM
742 int "Size in bytes of the EEPROM device"
745 config SYS_EEPROM_PAGE_WRITE_BITS
746 int "Number of bits used to address bytes in a single page"
747 depends on CMD_EEPROM
750 The EEPROM page size is 2^SYS_EEPROM_PAGE_WRITE_BITS.
751 A 64 byte page, for example would require six bits.
753 config SYS_EEPROM_PAGE_WRITE_DELAY_MS
754 int "Number of milliseconds to delay between page writes"
755 depends on CMD_EEPROM || CMD_I2C
761 Infinite write loop on address range
767 Compute MD5 checksum.
771 depends on CMD_MD5SUM
773 Add -v option to verify data against an MD5 checksum.
778 Display memory information.
781 bool "md, mm, nm, mw, cp, cmp, base, loop"
786 mm - memory modify (auto-incrementing address)
787 nm - memory modify (constant address)
788 mw - memory write (fill)
791 base - print or set address offset
792 loop - initialize loop on address range
794 config CMD_MEM_SEARCH
795 bool "ms - Memory search"
797 Memory-search command
799 This allows searching through a region of memory looking for hex
800 data (byte, 16-bit word, 32-bit long, also 64-bit on machines that
801 support it). It is also possible to search for a string. The
802 command accepts a memory range and a list of values to search for.
803 The values need to appear in memory in the same order they are given
804 in the command. At most 10 matches can be returned at a time, but
805 pressing return will show the next 10 matches. Environment variables
806 are set for use with scripting (memmatches, memaddr, mempos).
809 bool "Enable cyclic md/mw commands"
810 depends on CMD_MEMORY
812 Add the "mdc" and "mwc" memory commands. These are cyclic
817 This command will print 4 bytes (10,11,12,13) each 500 ms.
819 => mwc.l 100 12345678 10
820 This command will write 12345678 to address 100 all 10 ms.
825 depends on CMD_MEMORY && (LIB_RAND || LIB_HW_RAND)
827 random - fill memory with random data
832 Simple RAM read/write test.
836 config SYS_ALT_MEMTEST
837 bool "Alternative test"
839 Use a more complete alternative memory test.
843 config SYS_ALT_MEMTEST_BITFLIP
847 The alternative memory test includes bitflip test since 2020.07.
848 The bitflip test significantly increases the overall test time.
849 Bitflip test can optionally be disabled here.
853 config SYS_MEMTEST_START
854 hex "default start address for mtest"
857 This is the default start address for mtest for simple read/write
858 test. If no arguments are given to mtest, default address is used
861 config SYS_MEMTEST_END
862 hex "default end address for mtest"
865 This is the default end address for mtest for simple read/write
866 test. If no arguments are given to mtest, default address is used
875 Compute SHA1 checksum.
877 config SHA1SUM_VERIFY
879 depends on CMD_SHA1SUM
881 Add -v option to verify data against a SHA1 checksum.
884 bool "strings - display strings in memory"
886 This works similarly to the Unix 'strings' command except that it
887 works with a memory range. String of printable characters found
888 within the range are displayed. The minimum number of characters
889 for a sequence to be considered a string can be provided.
893 menu "Compression commands"
897 default y if CMD_BOOTI
900 Support decompressing an LZMA (Lempel-Ziv-Markov chain algorithm)
905 default y if CMD_BOOTI
908 Support decompressing an LZ4 image from memory region.
912 default y if CMD_BOOTI
915 Uncompress a zip-compressed memory region.
919 select GZIP_COMPRESSED
921 Compress a memory region with zlib deflate method.
925 menu "Device access commands"
928 #depends on FLASH_CFI_DRIVER
931 ARM Ltd reference designs flash partition access
934 bool "adc - Access Analog to Digital Converters info and data"
936 depends on DM_REGULATOR
938 Shows ADC device info and permit printing one-shot analog converted
939 data from a named Analog to Digital Converter.
944 depends on PARTITIONS
946 Read/modify/write the fields of Bootloader Control Block, usually
947 stored on the flash "misc" partition with its structure defined in:
948 https://android.googlesource.com/platform/bootable/recovery/+/master/
949 bootloader_message/include/bootloader_message/bootloader_message.h
951 Some real-life use-cases include (but are not limited to):
952 - Determine the "boot reason" (and act accordingly):
953 https://source.android.com/devices/bootloader/boot-reason
954 - Get/pass a list of commands from/to recovery:
955 https://android.googlesource.com/platform/bootable/recovery
956 - Inspect/dump the contents of the BCB fields
959 bool "bind/unbind - Bind or unbind a device to/from a driver"
962 Bind or unbind a device to/from a driver from the command line.
963 This is useful in situations where a device may be handled by several
964 drivers. For example, this can be used to bind a UDC to the usb ether
965 gadget driver from the command line.
968 bool "clk - Show clock frequencies"
971 Shows clock frequences by calling a sock_clk_dump() hook function.
972 This is depreated in favour of using the CLK uclass and accessing
973 clock values from associated drivers. However currently no command
977 bool "demo - Demonstration commands for driver model"
980 Provides a 'demo' command which can be used to play around with
981 driver model. To use this properly you will need to enable one or
982 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
983 Otherwise you will always get an empty list of devices. The demo
984 devices are defined in the sandbox device tree, so the easiest
985 option is to use sandbox and pass the -d point to sandbox's
992 Enables the command "dfu" which is used to have U-Boot create a DFU
993 class device via USB. This command requires that the "dfu_alt_info"
994 environment variable be set and define the alt settings to expose to
998 bool "dm - Access to driver model information"
1001 Provides access to driver model data structures and information,
1002 such as a list of devices, list of uclasses and the state of each
1003 device (e.g. activated). This is not required for operation, but
1004 can be useful to see the state of driver model for debugging or
1008 bool "fastboot - Android fastboot support"
1011 This enables the command "fastboot" which enables the Android
1012 fastboot mode for the platform. Fastboot is a protocol for
1013 downloading images, flashing and device control used on
1014 Android devices. Fastboot requires either the network stack
1015 enabled or support for acting as a USB device.
1017 See doc/android/fastboot.rst for more information.
1020 bool "flinfo, erase, protect"
1022 depends on MTD || FLASH_CFI_DRIVER || MTD_NOR_FLASH
1025 flinfo - print FLASH memory information
1026 erase - FLASH memory
1027 protect - enable or disable FLASH write protection
1036 config CMD_FPGA_LOADBP
1037 bool "fpga loadbp - load partial bitstream (Xilinx only)"
1040 Supports loading an FPGA device from a bitstream buffer containing
1041 a partial bitstream.
1043 config CMD_FPGA_LOADFS
1044 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
1047 Supports loading an FPGA device from a FAT filesystem.
1049 config CMD_FPGA_LOADMK
1050 bool "fpga loadmk - load bitstream from image"
1053 Supports loading an FPGA device from a image generated by mkimage.
1055 config CMD_FPGA_LOADP
1056 bool "fpga loadp - load partial bitstream"
1059 Supports loading an FPGA device from a bitstream buffer containing
1060 a partial bitstream.
1062 config CMD_FPGA_LOAD_SECURE
1063 bool "fpga loads - loads secure bitstreams"
1065 select FPGA_LOAD_SECURE
1067 Enables the fpga loads command which is used to load secure
1068 (authenticated or encrypted or both) bitstreams on to FPGA.
1071 bool "fpgad - dump FPGA registers"
1073 (legacy, needs conversion to driver model)
1074 Provides a way to dump FPGA registers by calling the board-specific
1075 fpga_get_reg() function. This functions similarly to the 'md'
1079 bool "fuse - support for the fuse subssystem"
1081 (deprecated - needs conversion to driver model)
1082 This allows reading, sensing, programming or overriding fuses
1083 which control the behaviour of the device. The command uses the
1091 config CMD_GPIO_READ
1092 bool "gpio read - save GPIO value to variable"
1095 Enables the 'gpio read' command that saves the value
1096 of a GPIO pin to a variable.
1102 Control PWM channels, this allows invert/config/enable/disable PWM channels.
1105 bool "GPT (GUID Partition Table) command"
1106 select EFI_PARTITION
1107 select PARTITION_UUIDS
1110 Enable the 'gpt' command to ready and write GPT style partition
1114 bool "GPT Random UUID generation"
1117 Enable the generation of partitions with random UUIDs if none
1120 config CMD_GPT_RENAME
1121 bool "GPT partition renaming commands"
1124 Enables the 'gpt' command to interchange names on two GPT
1125 partitions via the 'gpt swap' command or to rename single
1126 partitions via the 'rename' command.
1129 bool "ide - Support for IDE drivers"
1132 Provides an 'ide' command which allows accessing the IDE drive,
1133 resetting the IDE interface, printing the partition table and
1134 geting device info. It also enables the 'diskboot' command which
1135 permits booting from an IDE drive.
1138 bool "io - Support for performing I/O accesses"
1140 Provides an 'iod' command to display I/O space and an 'iow' command
1141 to write values to the I/O space. This can be useful for manually
1142 checking the state of devices during boot when debugging device
1146 bool "iotrace - Support for tracing I/O activity"
1148 Provides an 'iotrace' command which supports recording I/O reads and
1149 writes in a trace buffer in memory . It also maintains a checksum
1150 of the trace records (even if space is exhausted) so that the
1151 sequence of I/O accesses can be verified.
1153 When debugging drivers it is useful to see what I/O accesses were
1154 done and in what order.
1156 Even if the individual accesses are of little interest it can be
1157 useful to verify that the access pattern is consistent each time
1158 an operation is performed. In this case a checksum can be used to
1159 characterise the operation of a driver. The checksum can be compared
1160 across different runs of the operation to verify that the driver is
1163 In particular, when performing major refactoring of the driver, where
1164 the access pattern should not change, the checksum provides assurance
1165 that the refactoring work has not broken the driver.
1167 This works by sneaking into the io.h heder for an architecture and
1168 redirecting I/O accesses through iotrace's tracing mechanism.
1170 For now no commands are provided to examine the trace buffer. The
1171 format is fairly simple, so 'md' is a reasonable substitute.
1173 Note: The checksum feature is only useful for I/O regions where the
1174 contents do not change outside of software control. Where this is not
1175 suitable you can fall back to manually comparing the addresses. It
1176 might be useful to enhance tracing to only checksum the accesses and
1177 not the data read/written.
1187 bool "w1 - Support for Dallas 1-Wire protocol"
1189 Dallas 1-wire protocol support
1195 Load a binary file over serial line.
1200 Load a binary over memory mapped.
1203 bool "loads - Load a file over serial in S-Record format"
1206 Load an S-Record file over serial line
1209 bool "Echo all characters received during a loads back to console"
1210 depends on CMD_LOADS
1212 If enabled, all characters received during a serial download (using
1213 the "loads" command) are echoed back. This might be needed by some
1214 terminal emulations (like "cu"), but may as well just take time on
1215 others. This sets the initial value of the "loads_echo" environment
1219 bool "saves - Save a file over serial in S-Record format"
1221 Provides a way to save a binary file using the Motorola S-Record
1222 format over the serial line.
1224 config SYS_LOADS_BAUD_CHANGE
1225 bool "Enable a temporary baudrate change during loads/saves command"
1226 depends on CMD_LOADS || CMD_SAVES
1228 config CMD_LOADXY_TIMEOUT
1229 int "loadxy_timeout"
1233 Initial timeout for loadx and loady commands. Zero means infinity.
1237 bool "lsblk - list block drivers and devices"
1239 Print list of available block device drivers, and for each, the list
1240 of known block devices.
1243 bool "MBR (Master Boot Record) command"
1244 select DOS_PARTITION
1246 Enable the 'mbr' command to ready and write MBR (Master Boot Record)
1247 style partition tables.
1253 Enable the command "misc" for accessing miscellaneous devices with
1254 a MISC uclass driver. The command provides listing all MISC devices
1255 as well as read and write functionalities via their drivers.
1261 MMC memory mapped support.
1265 config CMD_BKOPS_ENABLE
1266 bool "mmc bkops enable"
1269 Enable command for setting manual background operations handshake
1270 on a eMMC device. The feature is optionally available on eMMC devices
1271 conforming to standard >= 4.41.
1274 bool "Enable support for RPMB in the mmc command"
1275 depends on SUPPORT_EMMC_RPMB
1277 Enable the commands for reading, writing and programming the
1278 key for the Replay Protection Memory Block partition in eMMC.
1280 config CMD_MMC_SWRITE
1282 depends on MMC_WRITE
1285 Enable support for the "mmc swrite" command to write Android sparse
1294 Enable storage cloning over block devices, useful for
1295 initial flashing by external block device without network
1298 config CMD_OPTEE_RPMB
1299 bool "Enable read/write support on RPMB via OPTEE"
1300 depends on SUPPORT_EMMC_RPMB && OPTEE
1302 Enable the commands for reading, writing persistent named values
1303 in the Replay Protection Memory Block partition in eMMC by
1304 using Persistent Objects in OPTEE
1309 select MTD_PARTITIONS
1311 MTD commands support.
1315 depends on MULTIPLEXER
1317 List, select, and deselect mux controllers on the fly.
1321 default y if NAND_SUNXI
1322 depends on MTD_RAW_NAND
1327 config CMD_NAND_TRIMFFS
1328 bool "nand write.trimffs"
1329 default y if ARCH_SUNXI
1331 Allows one to skip empty pages when flashing something on a NAND.
1333 config CMD_NAND_LOCK_UNLOCK
1334 bool "nand lock/unlock"
1336 NAND locking support.
1338 config CMD_NAND_TORTURE
1341 NAND torture support.
1350 NVM Express device support
1353 bool "onenand - access to onenand device"
1356 OneNAND is a brand of NAND ('Not AND' gate) flash which provides
1357 various useful features. This command allows reading, writing,
1358 and erasing blocks. It allso provides a way to show and change
1359 bad blocks, and test the device.
1361 config USE_ONENAND_BOARD_INIT
1362 bool "Call onenand_board_init() in the onenand command"
1363 depends on CMD_ONENAND
1368 Enable the 'osd' command which allows to query information from and
1369 write text data to a on-screen display (OSD) device; a virtual device
1370 associated with a display capable of displaying a text overlay on the
1371 display it's associated with..
1375 depends on PARTITIONS
1376 select PARTITION_UUIDS
1378 Read and display information about the partition table on
1382 bool "pci - Access PCI devices"
1384 Provide access to PCI (Peripheral Interconnect Bus), a type of bus
1385 used on some devices to allow the CPU to communicate with its
1386 peripherals. Sub-commands allow bus enumeration, displaying and
1387 changing configuration space and a few other features.
1390 bool "pinmux - show pins muxing"
1392 default y if PINCTRL
1394 Parse all available pin-controllers and show pins muxing. This
1395 is useful for debug purpoer to check the pin muxing and to know if
1396 a pin is configured as a GPIO or as an alternate function.
1401 Poweroff/Shutdown the system
1404 bool "read - Read binary data from a partition"
1406 Provides low-level access to the data in a partition.
1408 config CMD_REMOTEPROC
1410 depends on REMOTEPROC
1412 Support for Remote Processor control
1415 bool "sata - Access SATA subsystem"
1418 SATA (Serial Advanced Technology Attachment) is a serial bus
1419 standard for connecting to hard drives and other storage devices.
1420 This command provides information about attached devices and allows
1421 reading, writing and other operations.
1423 SATA replaces PATA (originally just ATA), which stands for Parallel AT
1424 Attachment, where AT refers to an IBM AT (Advanced Technology)
1425 computer released in 1984.
1428 bool "scsi - Access to SCSI devices"
1431 This provides a 'scsi' command which provides access to SCSI (Small
1432 Computer System Interface) devices. The command provides a way to
1433 scan the bus, reset the bus, read and write data and get information
1437 bool "sdram - Print SDRAM configuration information"
1439 Provides information about attached SDRAM. This assumed that the
1440 SDRAM has an EEPROM with information that can be read using the
1441 I2C bus. This is only available on some boards.
1445 depends on DM_SPI_FLASH || SPI_FLASH
1446 default y if DM_SPI_FLASH
1451 bool "sf test - Allow testing of SPI flash"
1454 Provides a way to test that SPI flash is working correctly. The
1455 test is destructive, in that an area of SPI flash must be provided
1456 for the test to use. Performance information is also provided,
1457 measuring the performance of reading, writing and erasing in
1458 Mbps (Million Bits Per Second). This value should approximately
1459 equal the SPI bus speed for a single-bit-wide SPI bus, assuming
1460 everything is working properly.
1463 bool "sspi - Command to access spi device"
1466 SPI utility command.
1468 config DEFAULT_SPI_BUS
1469 int "default spi bus used by sspi command"
1473 config DEFAULT_SPI_MODE
1474 hex "default spi mode used by sspi command (see include/spi.h)"
1478 config CMD_TEMPERATURE
1479 bool "temperature - display the temperature from thermal sensors"
1480 depends on DM_THERMAL
1482 Provides a way to list thermal sensors and to get their readings.
1485 bool "tsi148 - Command to access tsi148 device"
1487 This provides various sub-commands to initialise and configure the
1488 Turndra tsi148 device. See the command help for full details.
1491 bool "Enable UFS - Universal Flash Subsystem commands"
1494 "This provides commands to initialise and configure universal flash
1498 bool "universe - Command to set up the Turndra Universe controller"
1500 This allows setting up the VMEbus provided by this controller.
1501 See the command help for full details.
1511 select USB_FUNCTION_SDP
1513 Enables the command "sdp" which is used to have U-Boot emulating the
1514 Serial Download Protocol (SDP) via USB.
1518 depends on USB_FUNCTION_ROCKUSB
1520 Rockusb protocol is widely used by Rockchip SoC based devices. It can
1521 read/write info, image to/from devices. This enable rockusb command
1522 support to communication with rockusb device. for more detail about
1523 this command, please read doc/README.rockusb.
1525 config CMD_USB_MASS_STORAGE
1526 bool "UMS usb mass storage"
1527 depends on USB_GADGET_DOWNLOAD
1528 select USB_FUNCTION_MASS_STORAGE
1529 depends on BLK && USB_GADGET
1531 Enables the command "ums" and the USB mass storage support to the
1532 export a block device: U-Boot, the USB device, acts as a simple
1533 external hard drive plugged on the host USB port.
1536 bool "Xen para-virtualized block device"
1540 Xen para-virtualized block device support
1547 VirtIO block device support
1553 This provides commands to control the watchdog timer devices.
1559 Enable the command "axi" for accessing AXI (Advanced eXtensible
1560 Interface) busses, a on-chip interconnect specification for managing
1561 functional blocks in SoC designs, which is also often used in designs
1562 involving FPGAs (e.g. communication with IP cores in Xilinx FPGAs).
1566 menu "Shell scripting commands"
1571 Print file to standard output
1577 Echo args to console
1583 Return true/false on integer compare.
1589 Run script from memory
1595 Evaluate boolean and math expressions and store the result in an env
1597 Also supports loading the value at a memory location into a variable.
1598 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
1600 config CMD_SETEXPR_FMT
1602 depends on CMD_SETEXPR
1604 Evaluate format string expression and store result in an environment
1609 menu "Android support commands"
1611 config CMD_AB_SELECT
1613 depends on ANDROID_AB
1615 On Android devices with more than one boot slot (multiple copies of
1616 the kernel and system images) this provides a command to select which
1617 slot should be used to boot from and register the boot attempt. This
1618 is used by the new A/B update model where one slot is updated in the
1619 background while running from the other slot.
1626 bool "Network commands"
1636 bootp - boot image via network using BOOTP/TFTP protocol
1640 depends on CMD_BOOTP
1642 Boot image via network using DHCP/TFTP protocol
1644 config BOOTP_MAY_FAIL
1645 bool "Allow for the BOOTP/DHCP server to not be found"
1646 depends on CMD_BOOTP
1648 If the DHCP server is not found after the configured retry count, the
1649 call will fail instead of starting over. This can be used to fail
1650 over to Link-local IP address configuration if the DHCP server is not
1653 config BOOTP_BOOTPATH
1654 bool "Request & store 'rootpath' from BOOTP/DHCP server"
1656 depends on CMD_BOOTP
1658 Even though the config is called BOOTP_BOOTPATH, it stores the
1659 path in the variable 'rootpath'.
1661 config BOOTP_VENDOREX
1662 bool "Support vendor extensions from BOOTP/DHCP server"
1663 depends on CMD_BOOTP
1665 config BOOTP_BOOTFILESIZE
1666 bool "Request & store 'bootfilesize' from BOOTP/DHCP server"
1667 depends on CMD_BOOTP
1670 bool "Request & store 'dnsip' from BOOTP/DHCP server"
1672 depends on CMD_BOOTP
1674 The primary DNS server is stored as 'dnsip'. If two servers are
1675 returned, you must set BOOTP_DNS2 to store that second server IP
1679 bool "Store 'dnsip2' from BOOTP/DHCP server"
1680 depends on BOOTP_DNS
1682 If a DHCP client requests the DNS server IP from a DHCP server,
1683 it is possible that more than one DNS serverip is offered to the
1684 client. If CONFIG_BOOTP_DNS2 is enabled, the secondary DNS
1685 server IP will be stored in the additional environment
1686 variable "dnsip2". The first DNS serverip is always
1687 stored in the variable "dnsip", when BOOTP_DNS is defined.
1689 config BOOTP_GATEWAY
1690 bool "Request & store 'gatewayip' from BOOTP/DHCP server"
1692 depends on CMD_BOOTP
1694 config BOOTP_HOSTNAME
1695 bool "Request & store 'hostname' from BOOTP/DHCP server"
1697 depends on CMD_BOOTP
1699 The name may or may not be qualified with the local domain name.
1701 config BOOTP_PREFER_SERVERIP
1702 bool "serverip variable takes precedent over DHCP server IP."
1703 depends on CMD_BOOTP
1705 By default a BOOTP/DHCP reply will overwrite the 'serverip' variable.
1707 With this option enabled, the 'serverip' variable in the environment
1708 takes precedence over DHCP server IP and will only be set by the DHCP
1709 server if not already set in the environment.
1711 config BOOTP_SUBNETMASK
1712 bool "Request & store 'netmask' from BOOTP/DHCP server"
1714 depends on CMD_BOOTP
1716 config BOOTP_NISDOMAIN
1717 bool "Request & store 'nisdomain' from BOOTP/DHCP server"
1718 depends on CMD_BOOTP
1720 config BOOTP_NTPSERVER
1721 bool "Request & store 'ntpserverip' from BOOTP/DHCP server"
1722 depends on CMD_BOOTP
1724 config BOOTP_TIMEOFFSET
1725 bool "Request & store 'timeoffset' from BOOTP/DHCP server"
1726 depends on CMD_BOOTP && CMD_SNTP
1731 Selecting this will allow capturing all Ethernet packets and store
1732 them in physical memory in a PCAP formated file,
1733 later to be analyzed by PCAP reader application (IE. WireShark).
1736 bool "Send PXE client arch to BOOTP/DHCP server"
1738 depends on CMD_BOOTP && CMD_PXE
1740 Supported for ARM, ARM64, and x86 for now.
1742 config BOOTP_PXE_CLIENTARCH
1744 depends on BOOTP_PXE
1745 default 0x16 if ARM64
1749 config BOOTP_VCI_STRING
1751 depends on CMD_BOOTP
1752 default "U-Boot.armv7" if CPU_V7A || CPU_V7M || CPU_V7R
1753 default "U-Boot.armv8" if ARM64
1754 default "U-Boot.arm" if ARM
1761 tftpboot - load file via network using TFTP protocol
1765 depends on CMD_TFTPBOOT
1767 TFTP put command, for uploading files to a server
1771 depends on CMD_TFTPBOOT
1773 Act as a TFTP server and boot the first received file
1775 config NET_TFTP_VARS
1776 bool "Control TFTP timeout and count through environment"
1777 depends on CMD_TFTPBOOT
1780 If set, allows controlling the TFTP timeout through the
1781 environment variable tftptimeout, and the TFTP maximum
1782 timeout count through the variable tftptimeoutcountmax.
1783 If unset, timeout and maximum are hard-defined as 1 second
1784 and 10 timouts per TFTP transfer.
1789 Boot image via network using RARP/TFTP protocol
1795 Boot image via network using NFS protocol.
1798 int "Timeout in milliseconds for NFS mounts"
1802 Timeout in milliseconds used in NFS protocol. If you encounter
1803 "ERROR: Cannot umount" in nfs command, try longer timeout such as
1806 config SYS_DISABLE_AUTOLOAD
1807 bool "Disable automatically loading files over the network"
1808 depends on CMD_BOOTP || CMD_DHCP || CMD_NFS || CMD_RARP
1810 Typically, commands such as "dhcp" will attempt to automatically
1811 load a file from the network, once the initial network configuration
1812 is complete. Enable this option to disable this behavior and instead
1813 require files to be loaded over the network by subsequent commands.
1819 wget is a simple command to download kernel, or other files,
1820 from a http server over TCP.
1826 If set, allows 802.3(clause 22) MII Management functions interface access
1827 The management interface specified in Clause 22 provides
1828 a simple, two signal, serial interface to connect a
1829 Station Management entity and a managed PHY for providing access
1830 to management parameters and services.
1831 The interface is referred to as the MII management interface.
1834 bool "Call mii_init() in the mii command"
1835 depends on CMD_MII && (MPC8XX_FEC || FSLDMAFE || MCFFEC)
1841 If set, allows Enable 802.3(clause 45) MDIO interface registers access
1842 The MDIO interface is orthogonal to the MII interface and extends
1843 it by adding access to more registers through indirect addressing.
1848 Send ICMP ECHO_REQUEST to network host
1853 default y if (CMD_PING && IPV6)
1855 Send ICMPv6 ECHO_REQUEST to network host
1860 Perform CDP network configuration
1866 Synchronize RTC via network
1871 Lookup the IP of a hostname
1873 config CMD_LINK_LOCAL
1877 Acquire a network IP address using the link-local protocol
1883 Manually configure the attached NIC via NC-SI.
1884 Normally this happens automatically before other network
1892 Allow control of L2 Ethernet switch commands. These are supported
1893 by the vsc9953 Ethernet driver at present. Sub-commands allow
1894 operations such as enabling / disabling a port and
1895 viewing/maintaining the filtering database (FDB)
1901 Boot image via network using PXE protocol
1906 Wait for wake-on-lan Magic Packet
1910 menu "Misc commands"
1913 bool "Enable 'bmp' command"
1916 This provides a way to obtain information about a BMP-format image
1917 and to display it. BMP (which presumably stands for BitMaP) is a
1918 file format defined by Microsoft which supports images of various
1919 depths, formats and compression methods. Headers on the file
1920 determine the formats used. This command can be used by first loading
1921 the image into RAM, then using this command to look at it or display
1924 config CMD_BOOTCOUNT
1926 depends on BOOTCOUNT_LIMIT
1928 Enable the bootcount command, which allows interrogation and
1929 reset of the bootcounter.
1932 bool "Enable board-specific commands"
1934 (deprecated: instead, please define a Kconfig option for each command)
1936 Some boards have board-specific commands which are only enabled
1937 during developemnt and need to be turned off for production. This
1938 option provides a way to control this. The commands that are enabled
1939 vary depending on the board.
1941 config CMD_BLOCK_CACHE
1942 bool "blkcache - control and stats for block cache"
1943 depends on BLOCK_CACHE
1944 default y if BLOCK_CACHE
1946 Enable the blkcache command, which can be used to control the
1947 operation of the cache functions.
1948 This is most useful when fine-tuning the operation of the cache
1949 during development, but also allows the cache to be disabled when
1950 it might hurt performance (e.g. when using the ums command).
1957 Enable the 'button' command which allows to get the status of
1958 buttons supported by the board. The buttonss can be listed with
1959 'button list' and state can be known with 'button <label>'.
1960 Any button drivers can be controlled with this command, e.g.
1964 bool "icache or dcache"
1966 Enable the "icache" and "dcache" commands
1968 config CMD_CONITRACE
1969 bool "conitrace - trace console input codes"
1971 Enable the 'conitrace' command which displays the codes received
1972 from the console input as hexadecimal numbers.
1975 bool "Enable clear screen command 'cls'"
1976 default y if LCD || VIDEO
1978 Enable the 'cls' command which clears the screen contents
1979 on video frame buffer.
1982 bool "efidebug - display/configure UEFI environment"
1983 depends on EFI_LOADER
1984 select EFI_DEVICE_PATH_TO_TEXT
1986 Enable the 'efidebug' command which provides a subset of UEFI
1987 shell utility with simplified functionality. It will be useful
1988 particularly for managing boot parameters as well as examining
1989 various EFI status for debugging.
1991 config CMD_EFICONFIG
1992 bool "eficonfig - provide menu-driven uefi variables maintenance interface"
1993 depends on CMD_BOOTEFI_BOOTMGR
1995 Enable the 'eficonfig' command which provides the menu-driven UEFI
1996 variable maintenance interface.
1998 config CMD_EXCEPTION
1999 bool "exception - raise exception"
2000 depends on ARM || RISCV || SANDBOX || X86
2002 Enable the 'exception' command which allows to raise an exception.
2009 Enable the 'led' command which allows for control of LEDs supported
2010 by the board. The LEDs can be listed with 'led list' and controlled
2011 with led on/off/togle/blink. Any LED drivers can be controlled with
2012 this command, e.g. led_gpio.
2019 Enable the 'date' command for getting/setting the time/date in RTC
2026 Enable the 'rtc' command for low-level access to RTC devices.
2031 Run commands and summarize execution time.
2034 bool "gettime - read elapsed time"
2036 Enable the 'gettime' command which reads the elapsed time since
2037 U-Boot started running. This shows the time in seconds and
2038 milliseconds. See also the 'bootstage' command which provides more
2039 flexibility for boot timing.
2042 bool "pause command"
2044 Delay execution waiting for any user input.
2045 Useful to allow the user to read a failure log.
2050 default y if SANDBOX
2053 Print bytes from the hardware random number generator.
2055 config CMD_KASLRSEED
2059 Set the kaslr-seed in the chosen node with entropy provided by a
2060 hardware random number generator.
2066 Delay execution for some time
2069 bool "support for multiprocessor commands"
2073 This enables commands to bringup different processors
2074 in multiprocessor cases.
2079 Access the system timer.
2085 This provides basic access to the U-Boot's sound support. The main
2086 feature is to play a beep.
2088 sound init - set up sound system
2089 sound play - play a sound
2095 Boot image via local extlinux.conf file
2101 This provides access to the QEMU firmware interface. The main
2102 feature is to allow easy loading of files passed to qemu-system
2103 via -kernel / -initrd
2108 This provides access to Linux PStore with Rammoops backend. The main
2109 feature is to allow to display or save PStore records.
2111 See doc/pstore.rst for more information.
2115 config CMD_PSTORE_MEM_ADDR
2116 hex "Memory Address"
2117 depends on CMD_PSTORE
2119 Base addr used for PStore ramoops memory, should be identical to
2120 ramoops.mem_address parameter used by kernel
2122 config CMD_PSTORE_MEM_SIZE
2124 depends on CMD_PSTORE
2127 Size of PStore ramoops memory, should be identical to ramoops.mem_size
2128 parameter used by kernel, a power of 2 and larger than the sum of the
2131 config CMD_PSTORE_RECORD_SIZE
2132 hex "Dump record size"
2133 depends on CMD_PSTORE
2136 Size of each dump done on oops/panic, should be identical to
2137 ramoops.record_size parameter used by kernel and a power of 2
2140 config CMD_PSTORE_CONSOLE_SIZE
2141 hex "Kernel console log size"
2142 depends on CMD_PSTORE
2145 Size of kernel console log, should be identical to
2146 ramoops.console_size parameter used by kernel and a power of 2
2149 config CMD_PSTORE_FTRACE_SIZE
2150 hex "FTrace log size"
2151 depends on CMD_PSTORE
2154 Size of ftrace log, should be identical to ramoops.ftrace_size
2155 parameter used by kernel and a power of 2
2157 config CMD_PSTORE_PMSG_SIZE
2158 hex "User space message log size"
2159 depends on CMD_PSTORE
2162 Size of user space message log, should be identical to
2163 ramoops.pmsg_size parameter used by kernel and a power of 2
2165 config CMD_PSTORE_ECC_SIZE
2167 depends on CMD_PSTORE
2170 if non-zero, the option enables ECC support and specifies ECC buffer
2171 size in bytes (1 is a special value, means 16 bytes ECC), should be
2172 identical to ramoops.ramoops_ecc parameter used by kernel
2176 source "cmd/mvebu/Kconfig"
2179 bool "terminal - provides a way to attach a serial terminal"
2181 Provides a 'cu'-like serial terminal command. This can be used to
2182 access other serial ports from the system console. The terminal
2183 is very simple with no special processing of characters. As with
2184 cu, you can press ~. (tilde followed by period) to exit.
2187 bool "uuid, guid - generation of unique IDs"
2190 This enables two commands:
2192 uuid - generate random Universally Unique Identifier
2193 guid - generate Globally Unique Identifier based on random UUID
2195 The two commands are very similar except for the endianness of the
2198 config CMD_VIDCONSOLE
2199 bool "lcdputs and setcurs"
2203 Enabling this will provide 'setcurs' and 'lcdputs' commands which
2204 support cursor positioning and drawing strings on the video
2205 console (framebuffer).
2207 The name 'lcdputs' is a bit of a misnomer, but so named because the
2208 video device is often an LCD.
2212 source "cmd/ti/Kconfig"
2214 config CMD_BOOTSTAGE
2215 bool "Enable the 'bootstage' command"
2216 depends on BOOTSTAGE
2218 Add a 'bootstage' command which supports printing a report
2219 and un/stashing of bootstage data.
2221 menu "Power commands"
2223 bool "Enable Driver Model PMIC command"
2226 This is the pmic command, based on a driver model pmic's API.
2227 Command features are unchanged:
2228 - list - list pmic devices
2229 - pmic dev <id> - show or [set] operating pmic device (NEW)
2230 - pmic dump - dump registers
2231 - pmic read address - read byte of register at address
2232 - pmic write address - write byte to register at address
2233 The only one change for this command is 'dev' subcommand.
2235 config CMD_REGULATOR
2236 bool "Enable Driver Model REGULATOR command"
2237 depends on DM_REGULATOR
2239 This command is based on driver model regulator's API.
2240 User interface features:
2241 - list - list regulator devices
2242 - regulator dev <id> - show or [set] operating regulator device
2243 - regulator info - print constraints info
2244 - regulator status - print operating status
2245 - regulator value <val] <-f> - print/[set] voltage value [uV]
2246 - regulator current <val> - print/[set] current value [uA]
2247 - regulator mode <id> - print/[set] operating mode id
2248 - regulator enable - enable the regulator output
2249 - regulator disable - disable the regulator output
2251 The '-f' (force) option can be used for set the value which exceeds
2252 the limits, which are found in device-tree and are kept in regulator's
2253 uclass plat structure.
2257 menu "Security commands"
2259 bool "Enable the 'aes' command"
2262 This provides a means to encrypt and decrypt data using the AES
2263 (Advanced Encryption Standard). This algorithm uses a symetric key
2264 and is widely used as a streaming cipher. Different key lengths are
2265 supported by the algorithm but this command only supports 128 bits
2269 bool "Enable the 'blob' command"
2270 depends on !MX6ULL && !MX6SLL && !MX6SL
2271 select IMX_HAB if ARCH_MX6 || ARCH_MX7 || ARCH_MX7ULP || ARCH_IMX8M
2273 This is used with the Freescale secure boot mechanism.
2275 Freescale's SEC block has built-in Blob Protocol which provides
2276 a method for protecting user-defined data across system power
2277 cycles. SEC block protects data in a data structure called a Blob,
2278 which provides both confidentiality and integrity protection.
2280 Encapsulating data as a blob
2281 Each time that the Blob Protocol is used to protect data, a
2282 different randomly generated key is used to encrypt the data.
2283 This random key is itself encrypted using a key which is derived
2284 from SoC's non-volatile secret key and a 16 bit Key identifier.
2285 The resulting encrypted key along with encrypted data is called a
2286 blob. The non-volatile secure key is available for use only during
2289 During decapsulation, the reverse process is performed to get back
2293 blob enc - encapsulating data as a cryptgraphic blob
2294 blob dec - decapsulating cryptgraphic blob to get the data
2298 blob enc src dst len km
2300 Encapsulate and create blob of data $len bytes long
2301 at address $src and store the result at address $dst.
2302 $km is the 16 byte key modifier is also required for
2303 generation/use as key for cryptographic operation. Key
2304 modifier should be 16 byte long.
2306 blob dec src dst len km
2308 Decapsulate the blob of data at address $src and
2309 store result of $len byte at addr $dst.
2310 $km is the 16 byte key modifier is also required for
2311 generation/use as key for cryptographic operation. Key
2312 modifier should be 16 byte long.
2315 bool "Support 'hash' command"
2318 This provides a way to hash data in memory using various supported
2319 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
2320 saved to memory or to an environment variable. It is also possible
2321 to verify a hash against data in memory.
2324 bool "Support the 'hvc' command"
2325 depends on ARM_SMCCC
2327 Allows issuing Hypervisor Calls (HVCs). Mostly useful for
2328 development and testing.
2331 bool "Support the 'smc' command"
2332 depends on ARM_SMCCC
2334 Allows issuing Secure Monitor Calls (SMCs). Mostly useful for
2335 development and testing.
2341 Add -v option to verify data against a hash.
2344 bool "scp03 - SCP03 enable and rotate/provision operations"
2347 This command provides access to a Trusted Application
2348 running in a TEE to request Secure Channel Protocol 03
2349 (SCP03) enablement and/or rotation of its SCP03 keys.
2358 bool "Enable the 'tpm' command"
2359 depends on TPM_V1 || TPM_V2
2360 select CMD_TPM_V1 if TPM_V1
2361 select CMD_TPM_V2 if TPM_V2
2363 This provides a means to talk to a TPM from the command line. A wide
2364 range of commands if provided - see 'tpm help' for details. The
2365 command requires a suitable TPM on your board and the correct driver
2371 bool "Enable the 'tpm test' command"
2374 This provides a a series of tests to confirm that the TPMv1.x is
2375 working correctly. The tests cover initialisation, non-volatile RAM,
2376 extend, global lock and checking that timing is within expectations.
2377 The tests pass correctly on Infineon TPMs but may need to be adjusted
2384 menu "Firmware commands"
2386 bool "Enable crosec command"
2390 Enable command-line access to the Chrome OS EC (Embedded
2391 Controller). This provides the 'crosec' command which has
2392 a number of sub-commands for performing EC tasks such as
2393 updating its flash, accessing a small saved context area
2394 and talking to the I2C bus behind the EC (if there is one).
2397 menu "Filesystem commands"
2399 bool "Enable the 'btrsubvol' command"
2402 This enables the 'btrsubvol' command to list subvolumes
2403 of a BTRFS filesystem. There are no special commands for
2404 listing BTRFS directories or loading BTRFS files - this
2405 can be done by the generic 'fs' commands (see CMD_FS_GENERIC)
2406 when BTRFS is enabled (see FS_BTRFS).
2409 bool "Enable the 'cbfs' command"
2412 Define this to enable support for reading from a Coreboot
2413 filesystem. This is a ROM-based filesystem used for accessing files
2414 on systems that use coreboot as the first boot-loader and then load
2415 U-Boot to actually boot the Operating System. Available commands are
2416 cbfsinit, cbfsinfo, cbfsls and cbfsload.
2419 bool "Enable the 'cramfs' command"
2420 depends on FS_CRAMFS
2422 This provides commands for dealing with CRAMFS (Compressed ROM
2423 filesystem). CRAMFS is useful when space is tight since files are
2424 compressed. Two commands are provided:
2426 cramfsls - lists files in a cramfs image
2427 cramfsload - loads a file from a cramfs image
2430 bool "EROFS command support"
2433 Support for the EROFS fs
2436 bool "ext2 command support"
2439 Enables EXT2 FS command
2442 bool "ext4 command support"
2445 Enables EXT4 FS command
2447 config CMD_EXT4_WRITE
2449 bool "ext4 write command support"
2452 Enables EXT4 FS write command
2455 bool "FAT command support"
2458 Support for the FAT fs
2461 bool "SquashFS command support"
2464 Enables SquashFS filesystem commands (e.g. load, ls).
2466 config CMD_FS_GENERIC
2467 bool "filesystem commands"
2469 Enables filesystem commands (e.g. load, ls) that work for multiple
2473 bool "fsuuid command"
2475 Enables fsuuid command for filesystem UUID.
2478 bool "jffs2 command"
2481 Enables commands to support the JFFS2 (Journalling Flash File System
2482 version 2) filesystem. This enables fsload, ls and fsinfo which
2483 provide the ability to load files, list directories and obtain
2484 filesystem information.
2487 string "Default device for JFFS2"
2488 depends on CMD_JFFS2
2491 The default device to use with the jffs2 command.
2493 config JFFS2_PART_OFFSET
2494 hex "Default offset within flash to locate the JFFS2 image"
2495 depends on CMD_JFFS2
2498 The default offset within flash to locate the JFFS2 image.
2500 config JFFS2_PART_SIZE
2501 hex "Default size of JFFS2 partition"
2502 depends on CMD_JFFS2
2505 The default size of the JFFS2 partition
2508 bool "MTD partition support"
2511 MTD partitioning tool support.
2512 It is strongly encouraged to avoid using this command
2513 anymore along with 'sf', 'nand', 'onenand'. One can still
2514 declare the partitions in the mtdparts environment variable
2515 but better use the MTD stack and the 'mtd' command instead.
2517 config CMD_MTDPARTS_SPREAD
2518 bool "Padd partition size to take account of bad blocks"
2519 depends on CMD_MTDPARTS
2521 This enables the 'spread' sub-command of the mtdparts command.
2522 This command will modify the existing mtdparts variable by increasing
2523 the size of the partitions such that 1) each partition's net size is
2524 at least as large as the size specified in the mtdparts variable and
2525 2) each partition starts on a good block.
2527 config CMD_MTDPARTS_SHOW_NET_SIZES
2528 bool "Show net size (w/o bad blocks) of partitions"
2529 depends on CMD_MTDPARTS
2531 Adds two columns to the printed partition table showing the
2532 effective usable size of a partition, if bad blocks are taken
2535 config MTDIDS_DEFAULT
2536 string "Default MTD IDs"
2537 depends on MTD || SPI_FLASH
2539 Defines a default MTD IDs list for use with MTD partitions in the
2540 Linux MTD command line partitions format.
2542 config MTDPARTS_DEFAULT
2543 string "Default MTD partition scheme"
2544 depends on MTD || SPI_FLASH
2546 Defines a default MTD partitioning scheme in the Linux MTD command
2547 line partitions format
2550 bool "reiser - Access to reiserfs filesystems"
2552 This provides two commands which operate on a resierfs filesystem,
2553 commonly used some years ago:
2555 reiserls - list files
2556 reiserload - load a file
2559 bool "yaffs2 - Access of YAFFS2 filesystem"
2563 This provides commands for accessing a YAFFS2 filesystem. Yet
2564 Another Flash Filesystem 2 is a filesystem designed specifically
2565 for NAND flash. It incorporates bad-block management and ensures
2566 that device writes are sequential regardless of filesystem
2570 bool "zfs - Access of ZFS filesystem"
2572 This provides commands to accessing a ZFS filesystem, commonly used
2573 on Solaris systems. Two sub-commands are provided:
2575 zfsls - list files in a directory
2576 zfsload - load a file
2578 See doc/README.zfs for more details.
2582 menu "Debug commands"
2584 config CMD_CBSYSINFO
2587 default y if SYS_COREBOOT
2589 This provides information about the coreboot sysinfo table stored in
2590 memory by coreboot before jumping to U-Boot. It can be useful for
2591 debugging the beaaviour of coreboot or U-Boot.
2594 bool "cyclic - Show information about cyclic functions"
2598 This enables the 'cyclic' command which provides information about
2599 cyclic execution functions. This infrastructure allows registering
2600 functions to be executed cyclically, e.g. every 100ms. These commands
2603 cyclic list - list cyclic functions
2604 cyclic cyclic demo <cycletime_ms> <delay_us> - register cyclic
2607 See doc/develop/cyclic.rst for more details.
2610 bool "diag - Board diagnostics"
2612 This command provides access to board diagnostic tests. These are
2613 called Power-on Self Tests (POST). The command allows listing of
2614 available tests and running either all the tests, or specific tests
2618 bool "event - Show information about events"
2619 default y if EVENT_DEBUG
2621 This enables the 'event' command which provides information about
2622 events and event-handler routines. This can help to device event
2626 bool "irq - Show information about interrupts"
2627 depends on !ARM && !MIPS && !RISCV && !SH
2629 This enables two commands:
2631 interrupts - enable or disable interrupts
2632 irqinfo - print device-specific interrupt information
2635 bool "kgdb - Allow debugging of U-Boot with gdb"
2638 This enables a 'kgdb' command which allows gdb to connect to U-Boot
2639 over a serial link for debugging purposes. This allows
2640 single-stepping, inspecting variables, etc. This is supported only
2641 on PowerPC at present.
2644 bool "log - Generation, control and access to logging"
2648 This provides access to logging features. It allows the output of
2649 log data to be controlled to a limited extent (setting up the default
2650 maximum log level for emitting of records). It also provides access
2651 to a command used for testing the log system.
2654 bool "trace - Support tracing of function calls and timing"
2658 Enables a command to control using of function tracing within
2659 U-Boot. This allows recording of call traces including timing
2660 information. The command can write data to memory for exporting
2661 for analysis (e.g. using bootchart). See doc/README.trace for full
2665 bool "avb - Android Verified Boot 2.0 operations"
2666 depends on AVB_VERIFY
2668 Enables a "avb" command to perform verification of partitions using
2669 Android Verified Boot 2.0 functionality. It includes such subcommands:
2670 avb init - initialize avb2 subsystem
2671 avb read_rb - read rollback index
2672 avb write_rb - write rollback index
2673 avb is_unlocked - check device lock state
2674 avb get_uuid - read and print uuid of a partition
2675 avb read_part - read data from partition
2676 avb read_part_hex - read data from partition and output to stdout
2677 avb write_part - write data to partition
2678 avb verify - run full verification chain
2680 config CMD_STACKPROTECTOR_TEST
2681 bool "Test command for stack protector"
2682 depends on STACKPROTECTOR
2684 Enable stackprot_test command
2685 The stackprot_test command will force a stack overrun to test
2686 the stack smashing detection mechanisms.
2691 tristate "Enable UBI - Unsorted block images commands"
2694 UBI is a software layer above MTD layer which admits use of LVM-like
2695 logical volumes on top of MTD devices, hides some complexities of
2696 flash chips like wear and bad blocks and provides some other useful
2697 capabilities. Please, consult the MTD web site for more details
2698 (www.linux-mtd.infradead.org). Activate this option if you want
2699 to use U-Boot UBI commands.
2700 It is also strongly encouraged to also enable CONFIG_MTD to get full
2703 config CMD_UBI_RENAME
2704 bool "Enable rename"
2707 Enable a "ubi" command to rename ubi volume:
2708 ubi rename <oldname> <newname>
2711 tristate "Enable UBIFS - Unsorted block images filesystem commands"
2713 default y if CMD_UBI
2717 UBIFS is a file system for flash devices which works on top of UBI.
2719 config MMC_SPEED_MODE_SET
2720 bool "set speed mode using mmc command"
2724 Enable setting speed mode using mmc rescan and mmc dev commands.
2725 The speed mode is provided as the last argument in these commands
2726 and is indicated using the index from enum bus_mode in
2727 include/mmc.h. A speed mode can be set only if it has already
2728 been enabled in the device tree.
projects / platform / kernel / u-boot.git / blob