From: Ansuel Smith <ansuelsmth@gmail.com>
To: "Andrew Lunn" <andrew@lunn.ch>,
"Vivien Didelot" <vivien.didelot@gmail.com>,
"Florian Fainelli" <f.fainelli@gmail.com>,
"Vladimir Oltean" <olteanv@gmail.com>,
"David S. Miller" <davem@davemloft.net>,
"Jakub Kicinski" <kuba@kernel.org>,
"Rob Herring" <robh+dt@kernel.org>,
"Jonathan Corbet" <corbet@lwn.net>, "Pavel Machek" <pavel@ucw.cz>,
"Ansuel Smith" <ansuelsmth@gmail.com>,
"John Crispin" <john@phrozen.org>,
netdev@vger.kernel.org, devicetree@vger.kernel.org,
linux-kernel@vger.kernel.org, linux-doc@vger.kernel.org,
linux-leds@vger.kernel.org, "Marek Behún" <kabel@kernel.org>
Subject: [RFC PATCH v4 2/8] leds: document additional use of blink_set for hardware control
Date: Thu, 11 Nov 2021 02:34:54 +0100 [thread overview]
Message-ID: <20211111013500.13882-3-ansuelsmth@gmail.com> (raw)
In-Reply-To: <20211111013500.13882-1-ansuelsmth@gmail.com>
blink_set can now be used also to configure blink modes when hardware
control is supported and active.
Trigger will try to use blink_set and a LED driver will use the
trigger_data to configure the blink_modes once blink_set is called.
Setting a brightness to LED_OFF will reset any blink mode and disable
hardware control setting the LED off.
Signed-off-by: Ansuel Smith <ansuelsmth@gmail.com>
---
Documentation/leds/leds-class.rst | 17 +++++++++++++++++
drivers/leds/led-class.c | 7 +++++++
include/linux/leds.h | 9 +++++++++
3 files changed, 33 insertions(+)
diff --git a/Documentation/leds/leds-class.rst b/Documentation/leds/leds-class.rst
index 0175954717a3..c06a18b811de 100644
--- a/Documentation/leds/leds-class.rst
+++ b/Documentation/leds/leds-class.rst
@@ -202,6 +202,23 @@ hardware mode and any software only trigger will reject activation.
On init a LED driver that support a hardware mode should reset every blink mode
set by default.
+Once a trigger has declared support for hardware-controller blinks, it will use
+blink_set() to try to offload his trigger on activation/configuration.
+blink_set() will return 0 if the requested modes set in trigger_data can be
+controlled by hardware or an error if both the mode bitmap is not supported by
+the hardware or there was a problem in the configuration.
+
+Following blink_set logic, setting brightness to LED_OFF with hardware control active
+will reset any active blink mode and disable hardware control setting the LED to off.
+
+It's in the LED driver's interest to know how to elaborate the trigger data and report support
+for a particular set of blink modes. For this exact reason explicit support for the specific
+trigger is mandatory or the driver returns -EOPNOTSUPP if asked to enter hardware mode
+with a not supported trigger.
+If the driver returns -EOPNOTSUPP on hw_control_configure(), the trigger activation will
+fail as the driver doesn't support that specific hardware blink modes or doesn't know
+how to handle the provided trigger data.
+
Known Issues
============
diff --git a/drivers/leds/led-class.c b/drivers/leds/led-class.c
index 98a4dc889344..de39e76a7c6e 100644
--- a/drivers/leds/led-class.c
+++ b/drivers/leds/led-class.c
@@ -180,6 +180,13 @@ static int led_classdev_check_hw_control_functions(struct led_classdev *led_cdev
led_cdev->hw_control_stop))
return -EINVAL;
+ /* blink_set is mandatory to configure the blink modes
+ * in hardware control.
+ */
+ if ((LED_HARDWARE_CONTROLLED & led_cdev->flags) &&
+ !led_cdev->blink_set)
+ return -EINVAL;
+
return 0;
}
#endif
diff --git a/include/linux/leds.h b/include/linux/leds.h
index d64e5768e7ab..81d50269a446 100644
--- a/include/linux/leds.h
+++ b/include/linux/leds.h
@@ -76,6 +76,7 @@ struct led_classdev {
/* Lower 16 bits reflect status */
#define LED_SUSPENDED BIT(0)
#define LED_UNREGISTERING BIT(1)
+#define LED_HARDWARE_CONTROL BIT(2)
/* Upper 16 bits reflect control information */
#define LED_CORE_SUSPENDRESUME BIT(16)
#define LED_SYSFS_DISABLE BIT(17)
@@ -123,6 +124,12 @@ struct led_classdev {
* match the values specified exactly.
* Deactivate blinking again when the brightness is set to LED_OFF
* via the brightness_set() callback.
+ * With LED_HARDWARE_CONTROL set in LED flags blink_set will also
+ * configure blink modes requested by the current trigger if
+ * supported by the LED driver.
+ * Setting brightness to LED_OFF with hardware control active will
+ * reset any active blink mode and disable hardware control setting
+ * the LED off.
*/
int (*blink_set)(struct led_classdev *led_cdev,
unsigned long *delay_on,
@@ -166,6 +173,8 @@ struct led_classdev {
*/
bool (*hw_control_status)(struct led_classdev *led_cdev);
/* Set LED in hardware mode and reset any blink mode active by default.
+ * A trigger supporting hardware mode will have to use blink_set to configure
+ * the modes.
*/
int (*hw_control_start)(struct led_classdev *led_cdev);
/* Disable hardware mode for LED. It's advised to the LED driver to put it to
--
2.32.0
next prev parent reply other threads:[~2021-11-11 1:35 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2021-11-11 1:34 [RFC PATCH v4 0/8] Adds support for PHY LEDs with offload triggers Ansuel Smith
2021-11-11 1:34 ` [RFC PATCH v4 1/8] leds: add support for hardware driven LEDs Ansuel Smith
2021-11-11 2:24 ` Randy Dunlap
2021-11-11 1:34 ` Ansuel Smith [this message]
2021-11-11 2:28 ` [RFC PATCH v4 2/8] leds: document additional use of blink_set for hardware control Randy Dunlap
2021-11-11 1:34 ` [RFC PATCH v4 3/8] leds: trigger: netdev: drop NETDEV_LED_MODE_LINKUP from mode Ansuel Smith
2021-11-11 1:34 ` [RFC PATCH v4 4/8] leds: trigger: netdev: rename and expose NETDEV trigger enum and struct Ansuel Smith
2021-11-11 1:34 ` [RFC PATCH v4 5/8] leds: trigger: netdev: add hardware control support Ansuel Smith
2021-11-11 1:34 ` [RFC PATCH v4 6/8] leds: trigger: add hardware-phy-activity trigger Ansuel Smith
2021-11-11 2:18 ` Randy Dunlap
2021-11-11 1:34 ` [RFC PATCH v4 7/8] net: dsa: qca8k: add LEDs support Ansuel Smith
2021-11-11 2:19 ` Randy Dunlap
2021-11-11 1:35 ` [RFC PATCH v4 8/8] dt-bindings: net: dsa: qca8k: add LEDs definition example Ansuel Smith
2021-11-11 2:16 ` [RFC PATCH v4 0/8] Adds support for PHY LEDs with offload triggers Marek Behún
2021-11-12 15:35 ` Ansuel Smith
2021-11-12 18:30 ` Marek Behún
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=20211111013500.13882-3-ansuelsmth@gmail.com \
--to=ansuelsmth@gmail.com \
--cc=andrew@lunn.ch \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=devicetree@vger.kernel.org \
--cc=f.fainelli@gmail.com \
--cc=john@phrozen.org \
--cc=kabel@kernel.org \
--cc=kuba@kernel.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-leds@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=olteanv@gmail.com \
--cc=pavel@ucw.cz \
--cc=robh+dt@kernel.org \
--cc=vivien.didelot@gmail.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;
as well as URLs for NNTP newsgroup(s).