From patchwork Tue Jan  9 11:51:09 2024
Content-Type: text/plain; charset="utf-8"
MIME-Version: 1.0
Content-Transfer-Encoding: 7bit
X-Patchwork-Submitter: Caleb Connolly <caleb.connolly@linaro.org>
X-Patchwork-Id: 761052
Delivered-To: patch@linaro.org
Received: by 2002:a5d:6e02:0:b0:337:62d3:c6d5 with SMTP id h2csp1320998wrz;
 Tue, 9 Jan 2024 03:53:27 -0800 (PST)
X-Google-Smtp-Source: AGHT+IEvZfGraTQwN4Qz4Wh+bq6E+M3O2or4tM/h8GJxdxUkn1uPKGNw5EX6VOzimX5spzwqjb2I
X-Received: by 2002:a5d:638a:0:b0:336:5f5d:70aa with SMTP id
 p10-20020a5d638a000000b003365f5d70aamr433771wru.129.1704801207592;
 Tue, 09 Jan 2024 03:53:27 -0800 (PST)
ARC-Seal: i=1; a=rsa-sha256; t=1704801207; cv=none;
 d=google.com; s=arc-20160816;
 b=RhEwheSpcfOFXgy1Wtdgm9vOzYsFyM4E/Ce9EUwbizeEedFmW1uEDmz+aLHbVSc6Mc
 owvNVxs6TEMD9ABmOmo0NGnxPnGe3dZWkQ7p4wq+w+4H68dOsiuV1bCLeT23fwZJV5IP
 UmuOYMhgzRuWatde+H8WBNoXo0J/YXwgT1911jO8kMWebmg0QExGEv5ttpbVg86vS53g
 9XHLKjst9JY+lsa/VsZCXQdUGoVIhZxC0idB81h2iHfQTgwEpBS41BfNhNXu0dDGQn+O
 E0CcXHw0qsGzWjDzDKCV0D1tPeMHmDqZlrhbWCNysuFpHnraqDMH5ijC7kWRrQngHj2y
 4c9g==
ARC-Message-Signature: i=1; a=rsa-sha256; c=relaxed/relaxed; d=google.com;
 s=arc-20160816;
 h=sender:errors-to:list-subscribe:list-help:list-post:list-archive
 :list-unsubscribe:list-id:precedence:content-transfer-encoding
 :mime-version:message-id:date:subject:cc:to:from:dkim-signature;
 bh=oLNuw72sflaDdDkVNGqe8SXb8ph4kQY7q0fSNmk6Wis=;
 fh=rR0E0XMpBvjLoYuahhul57s1Ey5QWD0sC/xxWUMeFNo=;
 b=WetWJ+lvSUhQioWPnthQHWwv0iImn6gWwVqRuhWzEeCKfnPm+RNL/13mtETOSy/+pO
 g9bqIgzpPcTYmt7RdfH0dc1gbMqQk7q+1UA+qi5o4oAlk59GHa3ChObz4Fg86PMpx8EC
 GwzYhIk+KewJ9M5hUPdMruDAbZ+OeQgEZzH4ca0bARkhP4Eoh1yVfIrXT0fXzzfzP1Gp
 oiELsPMqBbcQcZdiCTjw+gJqMjEj6MPWendQNhpcUPxj9rxweN98z/mOjSJlYjIKJJN6
 bSEeOOGyacoF/UBrwBz1Ew2TvocsPIMSVxY0whYAh2j4zK7F1RDiHjgw/NBwZ1xeYdtM
 037g==
ARC-Authentication-Results: i=1; mx.google.com;
 dkim=pass header.i=@linaro.org header.s=google header.b=JgSDw+dC;
 spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates
 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; 
 dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org
Return-Path: <u-boot-bounces@lists.denx.de>
Received: from phobos.denx.de (phobos.denx.de. [85.214.62.61])
 by mx.google.com with ESMTPS id
 f4-20020adfb604000000b003367a5b9b25si870406wre.199.2024.01.09.03.53.27
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Tue, 09 Jan 2024 03:53:27 -0800 (PST)
Received-SPF: pass (google.com: domain of u-boot-bounces@lists.denx.de
 designates 85.214.62.61 as permitted sender) client-ip=85.214.62.61;
Authentication-Results: mx.google.com;
 dkim=pass header.i=@linaro.org header.s=google header.b=JgSDw+dC;
 spf=pass (google.com: domain of u-boot-bounces@lists.denx.de designates
 85.214.62.61 as permitted sender) smtp.mailfrom=u-boot-bounces@lists.denx.de; 
 dmarc=pass (p=NONE sp=NONE dis=NONE) header.from=linaro.org
Received: from h2850616.stratoserver.net (localhost [IPv6:::1])
 by phobos.denx.de (Postfix) with ESMTP id 69B9487800;
 Tue,  9 Jan 2024 12:53:26 +0100 (CET)
Authentication-Results: phobos.denx.de;
 dmarc=pass (p=none dis=none) header.from=linaro.org
Authentication-Results: phobos.denx.de;
 spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de
Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key;
 unprotected) header.d=linaro.org header.i=@linaro.org header.b="JgSDw+dC";
 dkim-atps=neutral
Received: by phobos.denx.de (Postfix, from userid 109)
 id 977DB87823; Tue,  9 Jan 2024 12:53:25 +0100 (CET)
X-Spam-Checker-Version: SpamAssassin 3.4.2 (2018-09-13) on phobos.denx.de
X-Spam-Level: 
X-Spam-Status: No, score=-2.1 required=5.0 tests=BAYES_00,DKIM_SIGNED,
 DKIM_VALID,DKIM_VALID_AU,DKIM_VALID_EF,SPF_HELO_NONE,SPF_PASS,
 T_SCC_BODY_TEXT_LINE autolearn=ham autolearn_force=no version=3.4.2
Received: from mail-wm1-x32d.google.com (mail-wm1-x32d.google.com
 [IPv6:2a00:1450:4864:20::32d])
 (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits))
 (No client certificate requested)
 by phobos.denx.de (Postfix) with ESMTPS id 7E9E98773F
 for <u-boot@lists.denx.de>; Tue,  9 Jan 2024 12:53:23 +0100 (CET)
Authentication-Results: phobos.denx.de;
 dmarc=pass (p=none dis=none) header.from=linaro.org
Authentication-Results: phobos.denx.de;
 spf=pass smtp.mailfrom=caleb.connolly@linaro.org
Received: by mail-wm1-x32d.google.com with SMTP id
 5b1f17b1804b1-40d5a41143fso31791835e9.3
 for <u-boot@lists.denx.de>; Tue, 09 Jan 2024 03:53:23 -0800 (PST)
DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=linaro.org; s=google; t=1704801203; x=1705406003; darn=lists.denx.de;
 h=content-transfer-encoding:mime-version:message-id:date:subject:cc
 :to:from:from:to:cc:subject:date:message-id:reply-to;
 bh=oLNuw72sflaDdDkVNGqe8SXb8ph4kQY7q0fSNmk6Wis=;
 b=JgSDw+dC12A1UBROTuJSTVe0v1BqoYOxMtrByA6hKIkc/ucx3fFEUqa6S1uenmFB3H
 E2UpRVKvoGBDMQWRgrWRE2+4SKsJep67jZswELlMk1nPOWw81Rgso3qPmNprfgeccjYV
 i0gvUfPYDMWLsdPxkJcN9dlC7dMh25Mov1mzPAR7XP2M58N1vKqGVkMCBPJBik4Ily1o
 RooHyCy+bGhkhZgRfuc3LZySNlbVqiDJqR4SJD2RYoICqkAspKCLGNJSlPl/yMeJjUWx
 Ph9WkYFghWHlwhgVzNM1IFAJDpoM57pBipM7ucxQqbfYaOSQKd0kG/xyENxNbIEzbASa
 V0qA==
X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed;
 d=1e100.net; s=20230601; t=1704801203; x=1705406003;
 h=content-transfer-encoding:mime-version:message-id:date:subject:cc
 :to:from:x-gm-message-state:from:to:cc:subject:date:message-id
 :reply-to;
 bh=oLNuw72sflaDdDkVNGqe8SXb8ph4kQY7q0fSNmk6Wis=;
 b=lIoK+8Ml/qP28R0vGw5q/oe8M2E2tvpVhfuXKTZfU3J+RSMg27YhuW1BIK0l4I8rA3
 0LQ6PZZkstyYTlWbodiiL/RBh6xsbJEM90LKFyn/zZN4ULC540eYctNGGwMlRLXGR7VR
 RM9AgFd08Zpy7aQejrtlALaxScffkewz1pbTtO+F/ETHfrbSNkjywyi6/wXsOIBH9HOt
 VL3R0t8OKb6OWE+PRVkM8gewb5LvUCtgJF6X+W516+KiVQ7zfizXPRhRoD9jUB6OtVz4
 3Q1FkHtwALrD8KWPw8EQ+pKrBAKlfq7R8SqKWUScEfx5R9bbFxfTOd6+VLM8I5Jo6U15
 DjNg==
X-Gm-Message-State: AOJu0YykFMwvfGxlGJy8Zs0lqVeRKbY3xAZRQEa6REN6IGR3L5lNOaeU
 qZnkHn8dj/RFc0QFisVQIPGRL26Jm04RWw==
X-Received: by 2002:a05:600c:45d2:b0:40e:5209:2311 with SMTP id
 s18-20020a05600c45d200b0040e52092311mr238453wmo.83.1704801202856;
 Tue, 09 Jan 2024 03:53:22 -0800 (PST)
Received: from lion.caleb.rex.connolly.tech (host-92-17-96-230.as13285.net.
 [92.17.96.230]) by smtp.gmail.com with ESMTPSA id
 p3-20020a05600c358300b0040d91930f93sm3260688wmq.11.2024.01.09.03.53.22
 (version=TLS1_3 cipher=TLS_AES_256_GCM_SHA384 bits=256/256);
 Tue, 09 Jan 2024 03:53:22 -0800 (PST)
From: Caleb Connolly <caleb.connolly@linaro.org>
To: Tom Rini <trini@konsulko.com>, Simon Glass <sjg@chromium.org>,
 Sumit Garg <sumit.garg@linaro.org>
Cc: u-boot@lists.denx.de, Caleb Connolly <caleb.connolly@linaro.org>,
 Svyatoslav Ryhel <clamor95@gmail.com>
Subject: [PATCH v2] boot: add support for button commands
Date: Tue,  9 Jan 2024 11:51:09 +0000
Message-ID: <20240109115310.1917139-1-caleb.connolly@linaro.org>
X-Mailer: git-send-email 2.42.1
MIME-Version: 1.0
X-BeenThere: u-boot@lists.denx.de
X-Mailman-Version: 2.1.39
Precedence: list
List-Id: U-Boot discussion <u-boot.lists.denx.de>
List-Unsubscribe: <https://lists.denx.de/options/u-boot>,
 <mailto:u-boot-request@lists.denx.de?subject=unsubscribe>
List-Archive: <https://lists.denx.de/pipermail/u-boot/>
List-Post: <mailto:u-boot@lists.denx.de>
List-Help: <mailto:u-boot-request@lists.denx.de?subject=help>
List-Subscribe: <https://lists.denx.de/listinfo/u-boot>,
 <mailto:u-boot-request@lists.denx.de?subject=subscribe>
Errors-To: u-boot-bounces@lists.denx.de
Sender: "U-Boot" <u-boot-bounces@lists.denx.de>
X-Virus-Scanned: clamav-milter 0.103.8 at phobos.denx.de
X-Virus-Status: Clean

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>
---
Changes since v1:
 * make get_button_cmd() static.
 * use #if IS_ENABLED(CONFIG_BUTTON_CMD) instead of #ifdef
   CONFIG_BUTTON_CMD.
 * Kconfig fixes
---
 boot/Kconfig              | 15 +++++++
 common/Makefile           |  1 +
 common/button_cmd.c       | 83 +++++++++++++++++++++++++++++++++++++++
 common/main.c             |  3 ++
 doc/usage/environment.rst |  4 ++
 include/button.h          |  9 +++++
 6 files changed, 115 insertions(+)
 create mode 100644 common/button_cmd.c

diff --git a/boot/Kconfig b/boot/Kconfig
index fbc49c5bca47..882835731ea9 100644
--- a/boot/Kconfig
+++ b/boot/Kconfig
@@ -20,6 +20,21 @@ config TIMESTAMP
 	  loaded that does not, the message 'Wrong FIT format: no timestamp'
 	  is shown.
 
+config BUTTON_CMD
+	bool "Support for running a command if a button is held during boot"
+	depends on CMDLINE
+	depends on BUTTON
+	help
+	  For many embedded devices it's useful to enter a special flashing mode
+	  such as fastboot mode when a button is held during boot. This option
+	  allows arbitrary commands to be assigned to specific buttons. These will
+	  be run after "preboot" if the button is held. Configuration is done via
+	  the environment variables "button_cmd_N_name" and "button_cmd_N" where n is
+	  the button number (starting from 0). e.g:
+
+	    "button_cmd_0_name=vol_down"
+	    "button_cmd_0=fastboot usb 0"
+
 menuconfig FIT
 	bool "Flattened Image Tree (FIT)"
 	select HASH
diff --git a/common/Makefile b/common/Makefile
index cdeadf72026c..53105a6ce12a 100644
--- a/common/Makefile
+++ b/common/Makefile
@@ -10,6 +10,7 @@ obj-y += main.o
 obj-y += exports.o
 obj-$(CONFIG_HUSH_PARSER) += cli_hush.o
 obj-$(CONFIG_AUTOBOOT) += autoboot.o
+obj-$(CONFIG_BUTTON_CMD) += button_cmd.o
 
 # # boards
 obj-y += board_f.o
diff --git a/common/button_cmd.c b/common/button_cmd.c
new file mode 100644
index 000000000000..b6a8434d6f29
--- /dev/null
+++ b/common/button_cmd.c
@@ -0,0 +1,83 @@
+// SPDX-License-Identifier: GPL-2.0+
+/*
+ * Copyright (c) 2023 Linaro Ltd.
+ *   Author: Caleb Connolly <caleb.connolly@linaro.org>
+ */
+
+#include <button.h>
+#include <command.h>
+#include <env.h>
+#include <log.h>
+#include <vsprintf.h>
+
+/* Some sane limit "just in case" */
+#define MAX_BTN_CMDS 32
+
+struct button_cmd {
+	bool pressed;
+	const char *btn_name;
+	const char *cmd;
+};
+
+/*
+ * Button commands are set via environment variables, e.g.:
+ * button_cmd_N_name=Volume Up
+ * button_cmd_N=fastboot usb 0
+ *
+ * This function will retrieve the command for the given button N
+ * and populate the cmd struct with the command string and pressed
+ * state of the button.
+ *
+ * Returns 1 if a command was found, 0 otherwise.
+ */
+static int get_button_cmd(int n, struct button_cmd *cmd)
+{
+	const char *cmd_str;
+	struct udevice *btn;
+	char buf[24];
+
+	snprintf(buf, sizeof(buf), "button_cmd_%d_name", n);
+	cmd->btn_name = env_get(buf);
+	if (!cmd->btn_name)
+		return 0;
+
+	button_get_by_label(cmd->btn_name, &btn);
+	if (!btn) {
+		log_err("No button labelled '%s'\n", cmd->btn_name);
+		return 0;
+	}
+
+	cmd->pressed = button_get_state(btn) == BUTTON_ON;
+	/* If the button isn't pressed then cmd->cmd will be unused so don't waste
+	 * cycles reading it
+	 */
+	if (!cmd->pressed)
+		return 1;
+
+	snprintf(buf, sizeof(buf), "button_cmd_%d", n);
+	cmd_str = env_get(buf);
+	if (!cmd_str) {
+		log_err("No command set for button '%s'\n", cmd->btn_name);
+		return 0;
+	}
+
+	cmd->cmd = cmd_str;
+
+	return 1;
+}
+
+void process_button_cmds(void)
+{
+	struct button_cmd cmd = {0};
+	int i = 0;
+
+	while (get_button_cmd(i++, &cmd) && i < MAX_BTN_CMDS) {
+		if (!cmd.pressed)
+			continue;
+
+		log_info("BTN '%s'> %s\n", cmd.btn_name, cmd.cmd);
+		run_command(cmd.cmd, CMD_FLAG_ENV);
+		/* Don't run commands for multiple buttons */
+		return;
+	}
+}
diff --git a/common/main.c b/common/main.c
index 7c70de2e59a8..717e8b7e8bd2 100644
--- a/common/main.c
+++ b/common/main.c
@@ -8,6 +8,7 @@
 
 #include <common.h>
 #include <autoboot.h>
+#include <button.h>
 #include <bootstage.h>
 #include <cli.h>
 #include <command.h>
@@ -61,6 +62,8 @@ void main_loop(void)
 			efi_launch_capsules();
 	}
 
+	process_button_cmds();
+
 	s = bootdelay_process();
 	if (cli_process_fdt(&s))
 		cli_secure_boot_cmd(s);
diff --git a/doc/usage/environment.rst b/doc/usage/environment.rst
index c57b717caaf3..ce5a9627f025 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
diff --git a/include/button.h b/include/button.h
index 207f4a0f4dbd..8d38e521324d 100644
--- a/include/button.h
+++ b/include/button.h
@@ -74,4 +74,13 @@ enum button_state_t button_get_state(struct udevice *dev);
  */
 int button_get_code(struct udevice *dev);
 
+#if IS_ENABLED(CONFIG_BUTTON_CMD)
+/* Process button command mappings specified in the environment,
+ * running the commands for buttons which are pressed
+ */
+void process_button_cmds(void);
+#else
+static inline void process_button_cmds(void) {}
+#endif /* CONFIG_BUTTON_CMD */
+
 #endif