public inbox for u-boot@lists.denx.de
 help / color / mirror / Atom feed
From: Christian Marangi <ansuelsmth@gmail.com>
To: Simon Glass <sjg@chromium.org>, Tom Rini <trini@konsulko.com>,
	Joe Hershberger <joe.hershberger@ni.com>,
	Ramon Fried <rfried.dev@gmail.com>,
	AKASHI Takahiro <akashi.tkhro@gmail.com>,
	Christian Marangi <ansuelsmth@gmail.com>,
	Ilias Apalodimas <ilias.apalodimas@linaro.org>,
	Etienne Carriere <etienne.carriere@foss.st.com>,
	Caleb Connolly <caleb.connolly@linaro.org>,
	Algapally Santosh Sagar <santoshsagar.algapally@amd.com>,
	Sean Anderson <seanga2@gmail.com>,
	Eddie James <eajames@linux.ibm.com>,
	Mattijs Korpershoek <mkorpershoek@baylibre.com>,
	Alexander Gendin <agendin@matrox.com>,
	Yang Xiwen <forbidden405@outlook.com>,
	Dario Binacchi <dario.binacchi@amarulasolutions.com>,
	Heinrich Schuchardt <xypron.glpk@gmx.de>,
	Miquel Raynal <miquel.raynal@bootlin.com>,
	Arseniy Krasnov <avkrasnov@salutedevices.com>,
	Heiko Schocher <hs@denx.de>,
	Michael Trimarchi <michael@amarulasolutions.com>,
	Martin Kurbanov <mmkurbanov@salutedevices.com>,
	Alexey Romanov <avromanov@salutedevices.com>,
	Artur Rojek <artur@conclusive.pl>,
	Rasmus Villemoes <rasmus.villemoes@prevas.dk>,
	Leo Yu-Chi Liang <ycliang@andestech.com>,
	Vasileios Amoiridis <vassilisamir@gmail.com>,
	Mikhail Kshevetskiy <mikhail.kshevetskiy@iopsys.eu>,
	Michael Polyntsov <michael.polyntsov@iopsys.eu>,
	Doug Zobel <douglas.zobel@climate.com>,
	Marek Vasut <marex@denx.de>,
	u-boot@lists.denx.de, John Crispin <john@phrozen.org>
Subject: [PATCH v5 05/11] led: implement LED activity API
Date: Tue,  1 Oct 2024 14:24:38 +0200	[thread overview]
Message-ID: <20241001122511.8832-6-ansuelsmth@gmail.com> (raw)
In-Reply-To: <20241001122511.8832-1-ansuelsmth@gmail.com>

Implement LED activity API similar to BOOT LED API.

Usual activity might be a file transfer with TFTP, a flash write...

User of this API will call led_activity_on/off/blink() to signal these
kind of activity.

New Kconfig is implemented similar to BOOT LED, LED_ACTIVITY to
enable support for it.

It's introduced a new /options/u-boot property "activity-led" and
"activity-led-period" to define the activity LED label and the
default period when the activity LED is set to blink mode.

If "activity-led-period" is not defined, the value of 250 (ms) is
used by default.

If CONFIG_LED_BLINK or CONFIG_LED_SW_BLINK is not enabled,
led_boot_blink call will fallback to simple LED ON.

Signed-off-by: Christian Marangi <ansuelsmth@gmail.com>
---
 drivers/led/Kconfig      | 13 +++++++
 drivers/led/led-uclass.c | 81 +++++++++++++++++++++++++++++++++++++++-
 include/led.h            | 51 +++++++++++++++++++++++++
 3 files changed, 143 insertions(+), 2 deletions(-)

diff --git a/drivers/led/Kconfig b/drivers/led/Kconfig
index 59b007a7ef5..c98cbf92fab 100644
--- a/drivers/led/Kconfig
+++ b/drivers/led/Kconfig
@@ -20,6 +20,19 @@ config LED_BOOT
 
 	  [1] dtschema/schemas/options/u-boot.yaml
 
+config LED_ACTIVITY
+	bool "Enable LED activity support"
+	help
+	  Enable LED activity support.
+
+	  LED activity is a specific LED assigned to signal activity operation
+	  like file trasnfer, flash write/erase...
+
+	  Defined in Device Tree /options/u-boot node. Refer here for the supported
+	  options [1].
+
+	  [1] dtschema/schemas/options/u-boot.yaml
+
 config LED_BCM6328
 	bool "LED Support for BCM6328"
 	depends on LED && ARCH_BMIPS
diff --git a/drivers/led/led-uclass.c b/drivers/led/led-uclass.c
index 54113213dcf..05e09909b7d 100644
--- a/drivers/led/led-uclass.c
+++ b/drivers/led/led-uclass.c
@@ -163,6 +163,75 @@ int led_boot_blink(void)
 #endif
 #endif
 
+#ifdef CONFIG_LED_ACTIVITY
+static int led_activity_get(struct udevice **devp, int *period_ms)
+{
+	struct led_uc_priv *priv;
+	struct uclass *uc;
+	int ret;
+
+	ret = uclass_get(UCLASS_LED, &uc);
+	if (ret)
+		return ret;
+
+	priv = uclass_get_priv(uc);
+	if (!priv->activity_led_label)
+		return -ENOENT;
+
+	if (period_ms)
+		*period_ms = priv->activity_led_period;
+
+	return led_get_by_label(priv->activity_led_label, devp);
+}
+
+int led_activity_on(void)
+{
+	struct udevice *dev;
+	int ret;
+
+	ret = led_activity_get(&dev, NULL);
+	if (ret)
+		return ret;
+
+	return led_set_state(dev, LEDST_ON);
+}
+
+int led_activity_off(void)
+{
+	struct udevice *dev;
+	int ret;
+
+	ret = led_activity_get(&dev, NULL);
+	if (ret)
+		return ret;
+
+	return led_set_state(dev, LEDST_OFF);
+}
+
+#if defined(CONFIG_LED_BLINK) || defined(CONFIG_LED_SW_BLINK)
+int led_activity_blink(void)
+{
+	struct udevice *dev;
+	int period_ms, ret;
+
+	ret = led_activity_get(&dev, &period_ms);
+	if (ret)
+		return ret;
+
+	ret = led_set_period(dev, period_ms);
+	if (ret) {
+		if (ret != -ENOSYS)
+			return ret;
+
+		/* fallback to ON with no set_period and no SW_BLINK */
+		return led_set_state(dev, LEDST_ON);
+	}
+
+	return led_set_state(dev, LEDST_BLINK);
+}
+#endif
+#endif
+
 static int led_post_bind(struct udevice *dev)
 {
 	struct led_uc_plat *uc_plat = dev_get_uclass_plat(dev);
@@ -227,13 +296,21 @@ static int led_post_probe(struct udevice *dev)
 	return ret;
 }
 
-#ifdef CONFIG_LED_BOOT
+#if defined(CONFIG_LED_BOOT) || defined(CONFIG_LED_ACTIVITY)
 static int led_init(struct uclass *uc)
 {
 	struct led_uc_priv *priv = uclass_get_priv(uc);
 
+#ifdef CONFIG_LED_BOOT
 	priv->boot_led_label = ofnode_options_read_str("boot-led");
 	priv->boot_led_period = ofnode_options_read_int("boot-led-period", 250);
+#endif
+
+#ifdef CONFIG_LED_ACTIVITY
+	priv->activity_led_label = ofnode_options_read_str("activity-led");
+	priv->activity_led_period = ofnode_options_read_int("activity-led-period",
+							    250);
+#endif
 
 	return 0;
 }
@@ -245,7 +322,7 @@ UCLASS_DRIVER(led) = {
 	.per_device_plat_auto	= sizeof(struct led_uc_plat),
 	.post_bind	= led_post_bind,
 	.post_probe	= led_post_probe,
-#ifdef CONFIG_LED_BOOT
+#if defined(CONFIG_LED_BOOT) || defined(CONFIG_LED_ACTIVITY)
 	.init		= led_init,
 	.priv_auto	= sizeof(struct led_uc_priv),
 #endif
diff --git a/include/led.h b/include/led.h
index 49ec2998a33..19d92d6441a 100644
--- a/include/led.h
+++ b/include/led.h
@@ -54,14 +54,21 @@ struct led_uc_plat {
  * struct led_uc_priv - Private data the uclass stores about each device
  *
  * @boot_led_label:	Boot LED label
+ * @activity_led_label:	Activity LED label
  * @boot_led_dev:	Boot LED dev
+ * @activity_led_dev:	Activity LED dev
  * @boot_led_period:	Boot LED blink period
+ * @activity_led_period: Activity LED blink period
  */
 struct led_uc_priv {
 #ifdef CONFIG_LED_BOOT
 	const char *boot_led_label;
 	int boot_led_period;
 #endif
+#ifdef CONFIG_LED_ACTIVITY
+	const char *activity_led_label;
+	int activity_led_period;
+#endif
 };
 
 struct led_ops {
@@ -192,4 +199,48 @@ static inline int led_boot_blink(void)
 }
 #endif
 
+#ifdef CONFIG_LED_ACTIVITY
+
+/**
+ * led_activity_on() - turn ON the designated LED for activity
+ *
+ * Return: 0 if OK, -ve on error
+ */
+int led_activity_on(void);
+
+/**
+ * led_activity_off() - turn OFF the designated LED for activity
+ *
+ * Return: 0 if OK, -ve on error
+ */
+int led_activity_off(void);
+
+#if defined(CONFIG_LED_BLINK) || defined(CONFIG_LED_SW_BLINK)
+/**
+ * led_activity_blink() - turn ON the designated LED for activity
+ *
+ * Return: 0 if OK, -ve on error
+ */
+int led_activity_blink(void);
+#else
+/* If LED BLINK is not supported/enabled, fallback to LED ON */
+#define led_activity_blink led_activity_on
+#endif
+#else
+static inline int led_activity_on(void)
+{
+	return -ENOSYS;
+}
+
+static inline int led_activity_off(void)
+{
+	return -ENOSYS;
+}
+
+static inline int led_activity_blink(void)
+{
+	return -ENOSYS;
+}
+#endif
+
 #endif
-- 
2.45.2


  parent reply	other threads:[~2024-10-01 13:20 UTC|newest]

Thread overview: 30+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-10-01 12:24 [PATCH v5 00/11] led: introduce LED boot and activity function Christian Marangi
2024-10-01 12:24 ` [PATCH v5 01/11] led: toggle LED on initial SW blink Christian Marangi
2024-10-02 22:55   ` Simon Glass
2024-10-02 22:59     ` Christian Marangi
2024-10-03  6:22   ` Michael Nazzareno Trimarchi
2024-10-03 10:59     ` Christian Marangi
2024-10-01 12:24 ` [PATCH v5 02/11] dm: core: implement ofnode_options helpers Christian Marangi
2024-10-01 12:24 ` [PATCH v5 03/11] led: implement LED boot API Christian Marangi
2024-10-02 22:55   ` Simon Glass
2024-10-02 23:00     ` Christian Marangi
2024-10-03 17:30       ` Simon Glass
2024-11-02 19:33     ` Simon Glass
2024-11-02 19:36       ` Christian Marangi
2024-11-02 19:50         ` Simon Glass
2024-11-02 19:52           ` Christian Marangi
2024-11-03 14:46             ` Simon Glass
2024-11-04 23:13               ` Christian Marangi
2024-11-05 15:12                 ` Simon Glass
2024-11-05 15:15                   ` Christian Marangi
2024-10-01 12:24 ` [PATCH v5 04/11] common: board_r: rework BOOT LED handling Christian Marangi
2024-10-01 12:24 ` Christian Marangi [this message]
2024-10-02 22:55   ` [PATCH v5 05/11] led: implement LED activity API Simon Glass
2024-10-01 12:24 ` [PATCH v5 06/11] tftp: implement support for LED activity Christian Marangi
2024-10-01 12:24 ` [PATCH v5 07/11] mtd: " Christian Marangi
2024-10-02 22:55   ` Simon Glass
2024-10-01 12:24 ` [PATCH v5 08/11] ubi: " Christian Marangi
2024-10-01 12:24 ` [PATCH v5 09/11] doc: introduce led.rst documentation Christian Marangi
2024-10-01 12:24 ` [PATCH v5 10/11] test: dm: Add tests for LED boot and activity Christian Marangi
2024-10-01 12:24 ` [PATCH v5 11/11] test: dm: Expand ofnode options test with new helper Christian Marangi
2024-10-11 17:35 ` [PATCH v5 00/11] led: introduce LED boot and activity function Tom Rini

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241001122511.8832-6-ansuelsmth@gmail.com \
    --to=ansuelsmth@gmail.com \
    --cc=agendin@matrox.com \
    --cc=akashi.tkhro@gmail.com \
    --cc=artur@conclusive.pl \
    --cc=avkrasnov@salutedevices.com \
    --cc=avromanov@salutedevices.com \
    --cc=caleb.connolly@linaro.org \
    --cc=dario.binacchi@amarulasolutions.com \
    --cc=douglas.zobel@climate.com \
    --cc=eajames@linux.ibm.com \
    --cc=etienne.carriere@foss.st.com \
    --cc=forbidden405@outlook.com \
    --cc=hs@denx.de \
    --cc=ilias.apalodimas@linaro.org \
    --cc=joe.hershberger@ni.com \
    --cc=john@phrozen.org \
    --cc=marex@denx.de \
    --cc=michael.polyntsov@iopsys.eu \
    --cc=michael@amarulasolutions.com \
    --cc=mikhail.kshevetskiy@iopsys.eu \
    --cc=miquel.raynal@bootlin.com \
    --cc=mkorpershoek@baylibre.com \
    --cc=mmkurbanov@salutedevices.com \
    --cc=rasmus.villemoes@prevas.dk \
    --cc=rfried.dev@gmail.com \
    --cc=santoshsagar.algapally@amd.com \
    --cc=seanga2@gmail.com \
    --cc=sjg@chromium.org \
    --cc=trini@konsulko.com \
    --cc=u-boot@lists.denx.de \
    --cc=vassilisamir@gmail.com \
    --cc=xypron.glpk@gmx.de \
    --cc=ycliang@andestech.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox