diff options
| author | Caleb Connolly | 2024-01-09 11:51:09 +0000 |
|---|---|---|
| committer | Tom Rini | 2024-02-13 15:38:49 -0500 |
| commit | e761035b64235db8930eb15d2703dc3f43e99224 (patch) | |
| tree | 55a006d2199d296ed551840a84eaeab7ab64158f /doc | |
| parent | 348ea878508de90fdcc5a051cabe05d190e40e35 (diff) | |
boot: add support for button commands
With the relatively new button API in U-Boot, it's now much easier to
model the common usecase of mapping arbitrary actions to different
buttons during boot - for example entering fastboot mode, setting some
additional kernel cmdline arguments, or booting with a custom recovery
ramdisk, to name a few.
Historically, this functionality has been implemented in board code,
making it fixed for a given U-Boot binary and requiring the code be
duplicated and modified for every board.
Implement a generic abstraction to run an arbitrary command during boot
when a specific button is pressed. The button -> command mapping is
configured via environment variables with the following format:
button_cmd_N_name=<button label>
button_cmd_N=<command to run>
Where N is the mapping number starting from 0. For example:
button_cmd_0_name=vol_down
button_cmd_0=fastboot usb 0
This will cause the device to enter fastboot mode if volume down is held
during boot.
After we enter the cli loop the button commands are no longer valid,
this allows the buttons to additionally be used for navigating a boot
menu.
Tested-by: Svyatoslav Ryhel <clamor95@gmail.com> # Tegra30
Signed-off-by: Caleb Connolly <caleb.connolly@linaro.org>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/usage/environment.rst | 4 |
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst index 82b6ea7b6e7..ebf75fa948a 100644 --- a/doc/usage/environment.rst +++ b/doc/usage/environment.rst @@ -190,6 +190,10 @@ bootm_size bootstopkeysha256, bootdelaykey, bootstopkey See README.autoboot +button_cmd_0, button_cmd_0_name ... button_cmd_N, button_cmd_N_name + Used to map commands to run when a button is held during boot. + See CONFIG_BUTTON_CMD. + updatefile Location of the software update file on a TFTP server, used by the automatic software update feature. Please refer to |