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.
30 This string is displayed in the command line to the left of the
33 menu "Autoboot options"
39 This enables the autoboot. See doc/README.autoboot for detail.
42 bool "Stop autobooting via specific input key / string"
45 This option enables stopping (aborting) of the automatic
46 boot feature only by issuing a specific input key or
47 string. If not enabled, any input key will abort the
48 U-Boot automatic booting process and bring the device
49 to the U-Boot prompt for user input.
51 config AUTOBOOT_PROMPT
52 string "Autoboot stop prompt"
53 depends on AUTOBOOT_KEYED
54 default "Autoboot in %d seconds\\n"
56 This string is displayed before the boot delay selected by
57 CONFIG_BOOTDELAY starts. If it is not defined there is no
58 output indicating that autoboot is in progress.
60 Note that this define is used as the (only) argument to a
61 printf() call, so it may contain '%' format specifications,
62 provided that it also includes, sepearated by commas exactly
63 like in a printf statement, the required arguments. It is
64 the responsibility of the user to select only such arguments
65 that are valid in the given context.
67 config AUTOBOOT_ENCRYPTION
68 bool "Enable encryption in autoboot stopping"
69 depends on AUTOBOOT_KEYED
72 config AUTOBOOT_DELAY_STR
73 string "Delay autobooting via specific input key / string"
74 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
76 This option delays the automatic boot feature by issuing
77 a specific input key or string. If CONFIG_AUTOBOOT_DELAY_STR
78 or the environment variable "bootdelaykey" is specified
79 and this string is received from console input before
80 autoboot starts booting, U-Boot gives a command prompt. The
81 U-Boot prompt will time out if CONFIG_BOOT_RETRY_TIME is
82 used, otherwise it never times out.
84 config AUTOBOOT_STOP_STR
85 string "Stop autobooting via specific input key / string"
86 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
88 This option enables stopping (aborting) of the automatic
89 boot feature only by issuing a specific input key or
90 string. If CONFIG_AUTOBOOT_STOP_STR or the environment
91 variable "bootstopkey" is specified and this string is
92 received from console input before autoboot starts booting,
93 U-Boot gives a command prompt. The U-Boot prompt never
94 times out, even if CONFIG_BOOT_RETRY_TIME is used.
96 config AUTOBOOT_KEYED_CTRLC
97 bool "Enable Ctrl-C autoboot interruption"
98 depends on AUTOBOOT_KEYED && !AUTOBOOT_ENCRYPTION
101 This option allows for the boot sequence to be interrupted
102 by ctrl-c, in addition to the "bootdelaykey" and "bootstopkey".
103 Setting this variable provides an escape sequence from the
104 limited "password" strings.
106 config AUTOBOOT_STOP_STR_SHA256
107 string "Stop autobooting via SHA256 encrypted password"
108 depends on AUTOBOOT_KEYED && AUTOBOOT_ENCRYPTION
110 This option adds the feature to only stop the autobooting,
111 and therefore boot into the U-Boot prompt, when the input
112 string / password matches a values that is encypted via
113 a SHA256 hash and saved in the environment.
117 source "cmd/fastboot/Kconfig"
134 Print ".config" contents.
136 If this option is enabled, the ".config" file contents are embedded
137 in the U-Boot image and can be printed on the console by the "config"
138 command. This provides information of which options are enabled on
145 Print console devices and information.
150 Print information about available CPUs. This normally shows the
151 number of CPUs, type (e.g. manufacturer, architecture, product or
152 internal name) and clock frequency. Other information may be
153 available depending on the CPU driver.
159 Print GPL license text
169 Run the command stored in the environment "bootcmd", i.e.
170 "bootd" does the same thing as "run bootcmd".
176 Boot an application image from the memory.
181 Boot the Linux zImage
188 Boot an AArch64 Linux Kernel image from memory.
192 depends on EFI_LOADER
195 Boot an EFI image from memory.
197 config CMD_BOOTEFI_HELLO_COMPILE
198 bool "Compile a standard EFI hello world binary for testing"
199 depends on CMD_BOOTEFI && (ARM || X86)
202 This compiles a standard EFI hello world application with U-Boot so
203 that it can be used with the test/py testing framework. This is useful
204 for testing that EFI is working at a basic level, and for bringing
205 up EFI support on a new architecture.
207 No additional space will be required in the resulting U-Boot binary
208 when this option is enabled.
210 config CMD_BOOTEFI_HELLO
211 bool "Allow booting a standard EFI hello world for testing"
212 depends on CMD_BOOTEFI_HELLO_COMPILE
214 This adds a standard EFI hello world application to U-Boot so that
215 it can be used with the 'bootefi hello' command. This is useful
216 for testing that EFI is working at a basic level, and for bringing
217 up EFI support on a new architecture.
223 Add an ANSI terminal boot menu command.
226 bool "bootelf, bootvx"
229 Boot an ELF/vxWorks image from the memory.
232 bool "Flattened Device Tree utility commands"
236 Do FDT related setup before booting into the Operating System.
242 Start an application at a given address.
248 Run the command in the given environment variable.
254 Print header information for application image.
260 List all images found in flash
266 Extract a part of a multi-image.
273 menu "Environment commands"
276 bool "ask for env variable"
278 Ask for environment variable
296 Edit environment variable.
301 Allow for searching environment variables
307 Save all environment variables into the compiled-in persistent
310 config CMD_ENV_EXISTS
314 Check if a variable is defined in the environment for use in
317 config CMD_ENV_CALLBACK
318 bool "env callbacks - print callbacks and their associated variables"
320 Some environment variable have callbacks defined by
321 U_BOOT_ENV_CALLBACK. These are called when the variable changes.
322 For example changing "baudrate" adjust the serial baud rate. This
323 command lists the currently defined callbacks.
326 bool "env flags -print variables that have non-default flags"
328 Some environment variables have special flags that control their
329 behaviour. For example, serial# can only be written once and cannot
330 be deleted. This command shows the variables that have special
335 menu "Memory commands"
338 bool "md, mm, nm, mw, cp, cmp, base, loop"
343 mm - memory modify (auto-incrementing address)
344 nm - memory modify (constant address)
345 mw - memory write (fill)
348 base - print or set address offset
349 loop - initialize loop on address range
358 bool "eeprom - EEPROM subsystem"
360 (deprecated, needs conversion to driver model)
361 Provides commands to read and write EEPROM (Electrically Erasable
362 Programmable Read Only Memory) chips that are connected over an
365 config CMD_EEPROM_LAYOUT
366 bool "Enable layout-aware eeprom commands"
367 depends on CMD_EEPROM
369 (deprecated, needs conversion to driver model)
370 When enabled, additional eeprom sub-commands become available.
372 eeprom print - prints the contents of the eeprom in a human-readable
373 way (eeprom layout fields, and data formatted to be fit for human
376 eeprom update - allows user to update eeprom fields by specifying
377 the field name, and providing the new data in a human readable format
378 (same format as displayed by the eeprom print command).
380 Both commands can either auto detect the layout, or be told which
384 __weak int parse_layout_version(char *str)
385 - override to provide your own layout name parsing
386 __weak void __eeprom_layout_assign(struct eeprom_layout *layout,
388 - override to setup the layout metadata based on the version
389 __weak int eeprom_layout_detect(unsigned char *data)
390 - override to provide your own algorithm for detecting layout
393 - contains various printing and updating functions for common
394 types of eeprom fields. Can be used for defining
397 config EEPROM_LAYOUT_HELP_STRING
398 string "Tells user what layout names are supported"
399 depends on CMD_EEPROM_LAYOUT
400 default "<not defined>"
402 Help printed with the LAYOUT VERSIONS part of the 'eeprom'
410 Compute MD5 checksum.
415 depends on CMD_MD5SUM
417 Add -v option to verify data against an MD5 checksum.
422 Infinite write loop on address range
427 Simple RAM read/write test.
432 mdc - memory display cyclic
433 mwc - memory write cyclic
438 Display memory information.
443 Uncompress a zip-compressed memory region.
448 Compress a memory region with zlib deflate method.
452 menu "Device access commands"
455 bool "clk - Show clock frequencies"
458 Shows clock frequences by calling a sock_clk_dump() hook function.
459 This is depreated in favour of using the CLK uclass and accessing
460 clock values from associated drivers. However currently no command
464 bool "dm - Access to driver model information"
468 Provides access to driver model data structures and information,
469 such as a list of devices, list of uclasses and the state of each
470 device (e.g. activated). This is not required for operation, but
471 can be useful to see the state of driver model for debugging or
475 bool "demo - Demonstration commands for driver model"
478 Provides a 'demo' command which can be used to play around with
479 driver model. To use this properly you will need to enable one or
480 both of the demo devices (DM_DEMO_SHAPE and DM_DEMO_SIMPLE).
481 Otherwise you will always get an empty list of devices. The demo
482 devices are defined in the sandbox device tree, so the easiest
483 option is to use sandbox and pass the -d point to sandbox's
490 Load a binary file over serial line.
496 Load an S-Record file over serial line
499 bool "flinfo, erase, protect"
503 flinfo - print FLASH memory information
505 protect - enable or disable FLASH write protection
508 bool "GPT (GUID Partition Table) command"
509 select PARTITION_UUIDS
512 Enable the 'gpt' command to ready and write GPT style partition
516 #depends on FLASH_CFI_DRIVER
519 ARM Ltd reference designs flash partition access
524 MMC memory mapped support.
528 default y if NAND_SUNXI
533 config CMD_NAND_TRIMFFS
534 bool "nand write.trimffs"
535 default y if ARCH_SUNXI
537 Allows one to skip empty pages when flashing something on a NAND.
539 config CMD_NAND_LOCK_UNLOCK
540 bool "nand lock/unlock"
542 NAND locking support.
544 config CMD_NAND_TORTURE
547 NAND torture support.
553 select PARTITION_UUIDS
555 Read and display information about the partition table on
580 select USB_FUNCTION_DFU
582 Enables the command "dfu" which is used to have U-Boot create a DFU
583 class device via USB.
585 config CMD_USB_MASS_STORAGE
586 bool "UMS usb mass storage"
588 USB mass storage support
596 config CMD_FPGA_LOADBP
597 bool "fpga loadbp - load partial bitstream (Xilinx only)"
600 Supports loading an FPGA device from a bitstream buffer containing
603 config CMD_FPGA_LOADFS
604 bool "fpga loadfs - load bitstream from FAT filesystem (Xilinx only)"
607 Supports loading an FPGA device from a FAT filesystem.
609 config CMD_FPGA_LOADMK
610 bool "fpga loadmk - load bitstream from image"
613 Supports loading an FPGA device from a image generated by mkimage.
615 config CMD_FPGA_LOADP
616 bool "fpga loadp - load partial bitstream"
619 Supports loading an FPGA device from a bitstream buffer containing
623 bool "fpgad - dump FPGA registers"
625 (legacy, needs conversion to driver model)
626 Provides a way to dump FPGA registers by calling the board-specific
627 fpga_get_reg() function. This functions similarly to the 'md'
631 bool "fuse - support for the fuse subssystem"
633 (deprecated - needs conversion to driver model)
634 This allows reading, sensing, programming or overriding fuses
635 which control the behaviour of the device. The command uses the
638 config CMD_REMOTEPROC
640 depends on REMOTEPROC
642 Support for Remote Processor control
650 bool "fdcboot - Boot from floppy device"
652 The 'fdtboot' command allows booting an image from a floppy disk.
657 menu "Shell scripting commands"
669 Return true/false on integer compare.
675 Run script from memory
681 Evaluate boolean and math expressions and store the result in an env
683 Also supports loading the value at a memory location into a variable.
684 If CONFIG_REGEX is enabled, setexpr also supports a gsub function.
688 menu "Network commands"
691 bool "bootp, tftpboot"
696 bootp - boot image via network using BOOTP/TFTP protocol
697 tftpboot - boot image via network using TFTP protocol
702 TFTP put command, for uploading files to a server
707 Act as a TFTP server and boot the first received file
712 Boot image via network using RARP/TFTP protocol
717 Boot image via network using DHCP/TFTP protocol
723 Boot image via network using PXE protocol
729 Boot image via network using NFS protocol.
734 Enable MII utility commands.
739 Send ICMP ECHO_REQUEST to network host
744 Perform CDP network configuration
749 Synchronize RTC via network
754 Lookup the IP of a hostname
756 config CMD_LINK_LOCAL
759 Acquire a network IP address using the link-local protocol
764 Allow control of L2 Ethernet switch commands. These are supported
765 by the vsc9953 Ethernet driver at present. Sub-commands allow
766 operations such as enabling / disabling a port and
767 viewing/maintaining the filtering database (FDB)
774 bool "Enable 'bmp' command"
775 depends on LCD || DM_VIDEO || VIDEO
777 This provides a way to obtain information about a BMP-format iamge
778 and to display it. BMP (which presumably stands for BitMaP) is a
779 file format defined by Microsoft which supports images of various
780 depths, formats and compression methods. Headers on the file
781 determine the formats used. This command can be used by first loading
782 the image into RAM, then using this command to look at it or display
786 bool "Enable board-specific commands"
788 (deprecated: instead, please define a Kconfig option for each command)
790 Some boards have board-specific commands which are only enabled
791 during developemnt and need to be turned off for production. This
792 option provides a way to control this. The commands that are enabled
793 vary depending on the board.
795 config CMD_BKOPS_ENABLE
796 bool "mmc bkops enable"
800 Enable command for setting manual background operations handshake
801 on a eMMC device. The feature is optionally available on eMMC devices
802 conforming to standard >= 4.41.
804 config CMD_BLOCK_CACHE
805 bool "blkcache - control and stats for block cache"
806 depends on BLOCK_CACHE
807 default y if BLOCK_CACHE
809 Enable the blkcache command, which can be used to control the
810 operation of the cache functions.
811 This is most useful when fine-tuning the operation of the cache
812 during development, but also allows the cache to be disabled when
813 it might hurt performance (e.g. when using the ums command).
816 bool "icache or dcache"
818 Enable the "icache" and "dcache" commands
821 bool "Enable the 'display' command, for character displays"
823 (this needs porting to driver model)
824 This enables the 'display' command which allows a string to be
825 displayed on a simple board-specific display. Implement
826 display_putc() to use it.
832 Enable the 'led' command which allows for control of LEDs supported
833 by the board. The LEDs can be listed with 'led list' and controlled
834 with led on/off/togle/blink. Any LED drivers can be controlled with
835 this command, e.g. led_gpio.
841 Enable the 'date' command for getting/setting the time/date in RTC
847 Run commands and summarize execution time.
850 bool "gettime - read elapsed time"
852 Enable the 'gettime' command which reads the elapsed time since
853 U-Boot started running. This shows the time in seconds and
854 milliseconds. See also the 'bootstage' command which provides more
855 flexibility for boot timing.
857 # TODO: rename to CMD_SLEEP
862 Delay execution for some time
867 Access the system timer.
870 bool "getdcr, setdcr, getidcr, setidcr"
874 getdcr - Get an AMCC PPC 4xx DCR's value
875 setdcr - Set an AMCC PPC 4xx DCR's value
876 getidcr - Get a register value via indirect DCR addressing
877 setidcr - Set a register value via indirect DCR addressing
883 This provides basic access to the U-Boot's sound support. The main
884 feature is to play a beep.
886 sound init - set up sound system
887 sound play - play a sound
893 This provides access to the QEMU firmware interface. The main
894 feature is to allow easy loading of files passed to qemu-system
895 via -kernel / -initrd
897 source "cmd/mvebu/Kconfig"
902 bool "Enable the 'bootstage' command"
905 Add a 'bootstage' command which supports printing a report
906 and un/stashing of bootstage data.
908 menu "Power commands"
910 bool "Enable Driver Model PMIC command"
913 This is the pmic command, based on a driver model pmic's API.
914 Command features are unchanged:
915 - list - list pmic devices
916 - pmic dev <id> - show or [set] operating pmic device (NEW)
917 - pmic dump - dump registers
918 - pmic read address - read byte of register at address
919 - pmic write address - write byte to register at address
920 The only one change for this command is 'dev' subcommand.
923 bool "Enable Driver Model REGULATOR command"
924 depends on DM_REGULATOR
926 This command is based on driver model regulator's API.
927 User interface features:
928 - list - list regulator devices
929 - regulator dev <id> - show or [set] operating regulator device
930 - regulator info - print constraints info
931 - regulator status - print operating status
932 - regulator value <val] <-f> - print/[set] voltage value [uV]
933 - regulator current <val> - print/[set] current value [uA]
934 - regulator mode <id> - print/[set] operating mode id
935 - regulator enable - enable the regulator output
936 - regulator disable - disable the regulator output
938 The '-f' (force) option can be used for set the value which exceeds
939 the limits, which are found in device-tree and are kept in regulator's
940 uclass platdata structure.
944 menu "Security commands"
946 bool "Enable the 'aes' command"
949 This provides a means to encrypt and decrypt data using the AES
950 (Advanced Encryption Standard). This algorithm uses a symetric key
951 and is widely used as a streaming cipher. Different key lengths are
952 supported by the algorithm but this command only supports 128 bits
956 bool "Enable the 'blob' command"
958 This is used with the Freescale secure boot mechanism.
960 Freescale's SEC block has built-in Blob Protocol which provides
961 a method for protecting user-defined data across system power
962 cycles. SEC block protects data in a data structure called a Blob,
963 which provides both confidentiality and integrity protection.
965 Encapsulating data as a blob
966 Each time that the Blob Protocol is used to protect data, a
967 different randomly generated key is used to encrypt the data.
968 This random key is itself encrypted using a key which is derived
969 from SoC's non-volatile secret key and a 16 bit Key identifier.
970 The resulting encrypted key along with encrypted data is called a
971 blob. The non-volatile secure key is available for use only during
974 During decapsulation, the reverse process is performed to get back
978 blob enc - encapsulating data as a cryptgraphic blob
979 blob dec - decapsulating cryptgraphic blob to get the data
983 blob enc src dst len km
985 Encapsulate and create blob of data $len bytes long
986 at address $src and store the result at address $dst.
987 $km is the 16 byte key modifier is also required for
988 generation/use as key for cryptographic operation. Key
989 modifier should be 16 byte long.
991 blob dec src dst len km
993 Decapsulate the blob of data at address $src and
994 store result of $len byte at addr $dst.
995 $km is the 16 byte key modifier is also required for
996 generation/use as key for cryptographic operation. Key
997 modifier should be 16 byte long.
1000 bool "Support 'hash' command"
1002 This provides a way to hash data in memory using various supported
1003 algorithms (such as SHA1, MD5, CRC32). The computed digest can be
1004 saved to memory or to an environment variable. It is also possible
1005 to verify a hash against data in memory.
1008 bool "Enable the 'tpm' command"
1011 This provides a means to talk to a TPM from the command line. A wide
1012 range of commands if provided - see 'tpm help' for details. The
1013 command requires a suitable TPM on your board and the correct driver
1017 bool "Enable the 'tpm test' command"
1020 This provides a a series of tests to confirm that the TPM is working
1021 correctly. The tests cover initialisation, non-volatile RAM, extend,
1022 global lock and checking that timing is within expectations. The
1023 tests pass correctly on Infineon TPMs but may need to be adjusted
1028 menu "Firmware commands"
1030 bool "Enable crosec command"
1034 Enable command-line access to the Chrome OS EC (Embedded
1035 Controller). This provides the 'crosec' command which has
1036 a number of sub-commands for performing EC tasks such as
1037 updating its flash, accessing a small saved context area
1038 and talking to the I2C bus behind the EC (if there is one).
1041 menu "Filesystem commands"
1043 bool "Enable the 'cbfs' command"
1046 Define this to enable support for reading from a Coreboot
1047 filesystem. This is a ROM-based filesystem used for accessing files
1048 on systems that use coreboot as the first boot-loader and then load
1049 U-Boot to actually boot the Operating System. Available commands are
1050 cbfsinit, cbfsinfo, cbfsls and cbfsload.
1053 bool "Enable the 'cramfs' command"
1054 depends on FS_CRAMFS
1056 This provides commands for dealing with CRAMFS (Compressed ROM
1057 filesystem). CRAMFS is useful when space is tight since files are
1058 compressed. Two commands are provided:
1060 cramfsls - lists files in a cramfs image
1061 cramfsload - loads a file from a cramfs image
1064 bool "ext2 command support"
1066 Enables EXT2 FS command
1069 bool "ext4 command support"
1071 Enables EXT4 FS command
1073 config CMD_EXT4_WRITE
1075 bool "ext4 write command support"
1077 Enables EXT4 FS write command
1080 bool "FAT command support"
1082 Support for the FAT fs
1084 config CMD_FS_GENERIC
1085 bool "filesystem commands"
1087 Enables filesystem commands (e.g. load, ls) that work for multiple
1091 bool "fsuuid command"
1093 Enables fsuuid command for filesystem UUID.
1096 depends on ARCH_SUNXI
1097 bool "MTD partition support"
1099 MTD partition support
1101 config MTDIDS_DEFAULT
1102 string "Default MTD IDs"
1103 depends on CMD_MTDPARTS
1105 Defines a default MTD ID
1107 config MTDPARTS_DEFAULT
1108 string "Default MTD partition scheme"
1109 depends on CMD_MTDPARTS
1111 Defines a default MTD partitioning scheme in the Linux MTD command
1112 line partitions format
1116 menu "Debug commands"
1121 The bedbug (emBEDded deBUGger) command provides debugging features
1122 for some PowerPC processors. For details please see the
1123 docuemntation in doc/README.beddbug
1126 bool "diag - Board diagnostics"
1128 This command provides access to board diagnostic tests. These are
1129 called Power-on Self Tests (POST). The command allows listing of
1130 available tests and running either all the tests, or specific tests
1136 tristate "Enable UBI - Unsorted block images commands"
1139 default y if NAND_SUNXI
1141 UBI is a software layer above MTD layer which admits use of LVM-like
1142 logical volumes on top of MTD devices, hides some complexities of
1143 flash chips like wear and bad blocks and provides some other useful
1144 capabilities. Please, consult the MTD web site for more details
1145 (www.linux-mtd.infradead.org). Activate this option if you want
1146 to use U-Boot UBI commands.
1149 tristate "Enable UBIFS - Unsorted block images filesystem commands"
1152 select RBTREE if ARCH_SUNXI
1153 select LZO if ARCH_SUNXI
1154 default y if NAND_SUNXI
1156 UBIFS is a file system for flash devices which works on top of UBI.
projects / J-u-boot.git / blob