Skip to contentSkip to conversation

cmd: Add pause command

PATCH In review Samuel Dionne-Riel 2 participants 2 messages Aug 18, 2022 – Sep 3, 2022

lore
Share & tools
lore
#0 lore raw

PATCH v4 1/1 cmd: Add pause command

This command is being introduced with the goal of allowing user-friendly "generic use case" U-Boot builds to pause until user input under some situations.

The main use case would be when a boot failure happens, to pause until the user has had time to acknowledge the current state.

Tested using:

    make && ./u-boot -v -T -c 'ut lib lib_test_hush_pause'

---

Hi!

I believe everything is addressed. I took the comment about the sort order being wonky as needing no changes.

Changes for v4
- No functional change in command, mainly code style
- Addressed nits
- Added missing docs
- Wrote test fully in code

Changes for v3
- No functional change in patch
- Sent with lines unwrapped
- Added changelog

Changes for v2
- Added test, as requested by Tom
- Made CMD_PAUSE default n

---
 cmd/Kconfig                 |  6 +++++
 cmd/Makefile                |  1 +
 cmd/pause.c                 | 32 ++++++++++++++++++++++
 configs/sandbox64_defconfig |  1 +
 configs/sandbox_defconfig   |  1 +
 doc/usage/cmd/pause.rst     | 53 +++++++++++++++++++++++++++++++++++++
 doc/usage/index.rst         |  1 +
 test/cmd/Makefile           |  3 +++
 test/cmd/test_pause.c       | 45 +++++++++++++++++++++++++++++++
 9 files changed, 143 insertions(+)
 create mode 100644 cmd/pause.c
 create mode 100644 doc/usage/cmd/pause.rst
 create mode 100644 test/cmd/test_pause.c
cmd/Kconfig +6 -0
index 3625ff2a50b..e8d1f73cd0d 100644
@@ -1961,6 +1961,12 @@ config CMD_GETTIME
 	  milliseconds. See also the 'bootstage' command which provides more
 	  flexibility for boot timing.
 
+config CMD_PAUSE
+	bool "pause command"
+	help
+	  Delay execution waiting for any user input.
+	  Useful to allow the user to read a failure log.
+
 config CMD_RNG
 	bool "rng command"
 	depends on DM_RNG
cmd/Makefile +1 -0
index 5e43a1e022e..98a6224bdc1 100644
@@ -102,6 +102,7 @@ obj-$(CONFIG_CMD_MFSL) += mfsl.o
 obj-$(CONFIG_CMD_MII) += mii.o
 obj-$(CONFIG_CMD_MISC) += misc.o
 obj-$(CONFIG_CMD_MDIO) += mdio.o
+obj-$(CONFIG_CMD_PAUSE) += pause.o
 obj-$(CONFIG_CMD_SLEEP) += sleep.o
 obj-$(CONFIG_CMD_MMC) += mmc.o
 obj-$(CONFIG_CMD_OPTEE_RPMB) += optee_rpmb.o
cmd/pause.c new file +32 -0
new file mode 100644
index 00000000000..c97833c0d70
@@ -0,0 +1,32 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * (C) Copyright 2021
+ * Samuel Dionne-Riel <[email protected]>
+ */
+
+#include <command.h>
+#include <stdio.h>
+
+static int do_pause(struct cmd_tbl *cmdtp, int flag, int argc, char *const argv[])
+{
+	char *message = "Press any key to continue...";
+
+	if (argc == 2)
+		message = argv[1];
+
+	/* No newline, so it sticks to the bottom of the screen */
+	printf("%s", message);
+
+	/* Wait on "any" key... */
+	(void) getchar();
+
+	/* Since there was no newline, we need it now */
+	printf("\n");
+
+	return CMD_RET_SUCCESS;
+}
+
+U_BOOT_CMD(pause, 2, 1, do_pause,
+	"delay until user input",
+	"[prompt] - Wait until users presses any key. [prompt] can be used to customize the message.\n"
+);
configs/sandbox64_defconfig +1 -0
index 6553568e768..0af582d642d 100644
@@ -67,6 +67,7 @@ CONFIG_CMD_BMP=y
 CONFIG_CMD_EFIDEBUG=y
 CONFIG_CMD_RTC=y
 CONFIG_CMD_TIME=y
+CONFIG_CMD_PAUSE=y
 CONFIG_CMD_TIMER=y
 CONFIG_CMD_SOUND=y
 CONFIG_CMD_QFW=y
configs/sandbox_defconfig +1 -0
index eba7bcbb483..d856d9b0942 100644
@@ -96,6 +96,7 @@ CONFIG_CMD_BOOTCOUNT=y
 CONFIG_CMD_EFIDEBUG=y
 CONFIG_CMD_RTC=y
 CONFIG_CMD_TIME=y
+CONFIG_CMD_PAUSE=y
 CONFIG_CMD_TIMER=y
 CONFIG_CMD_SOUND=y
 CONFIG_CMD_QFW=y
doc/usage/cmd/pause.rst new file +53 -0

53 lines not on this page · raw message

doc/usage/index.rst +1 -0
index 2ba8733b92c..decfc2cc843 100644
@@ -51,6 +51,7 @@ Shell commands
    cmd/mbr
    cmd/md
    cmd/mmc
+   cmd/pause
    cmd/pinmux
    cmd/printenv
    cmd/pstore
test/cmd/Makefile +3 -0
index c331757425e..1bb02d93a23 100644
@@ -5,6 +5,9 @@
 ifdef CONFIG_HUSH_PARSER
 obj-$(CONFIG_CONSOLE_RECORD) += test_echo.o
 endif
+ifdef CONFIG_CONSOLE_RECORD
+obj-$(CONFIG_CMD_PAUSE) += test_pause.o
+endif
 obj-y += mem.o
 obj-$(CONFIG_CMD_ADDRMAP) += addrmap.o
 obj-$(CONFIG_CMD_FDT) += fdt.o
test/cmd/test_pause.c new file +45 -0

45 lines not on this page · raw message

Signature · 4 lines
2.35.1

-- 
Samuel Dionne-Riel
#1 lore raw
Quoted 7 lines · Samuel Dionne-Riel

This command is being introduced with the goal of allowing user-friendly "generic use case" U-Boot builds to pause until user input under some situations.

The main use case would be when a boot failure happens, to pause until the user has had time to acknowledge the current state.

Quoted 6 lines

Tested using:

    make && ./u-boot -v -T -c 'ut lib lib_test_hush_pause'

Applied to u-boot/next, thanks!

Signature · 1 line
Tom