mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Johann Neuhauser <jneuhauser@dh-electronics.com>
To: <linux-kernel@vger.kernel.org>, <linux-doc@vger.kernel.org>
Cc: Johann Neuhauser <jneuhauser@dh-electronics.com>,
	Jonathan Corbet <corbet@lwn.net>,
	Liam Girdwood <lgirdwood@gmail.com>,
	Mark Brown <broonie@kernel.org>
Subject: [PATCH 2/3] ABI: sysfs-platform: Document uevent ABI for reg-userspace-consumer
Date: Fri, 4 Apr 2025 15:40:08 +0200	[thread overview]
Message-ID: <20250404134009.2610460-3-jneuhauser@dh-electronics.com> (raw)
In-Reply-To: <20250404134009.2610460-1-jneuhauser@dh-electronics.com>

Document the new uevent-based ABI provided by the userspace-consumer
regulator driver. These uevents expose regulator events such as OVER_CURRENT,
ENABLE, DISABLE, UNDER_VOLTAGE, and others to userspace.

Clearly describe the ABI entries and possible event values to ensure stable
and predictable userspace integration.

Signed-off-by: Johann Neuhauser <jneuhauser@dh-electronics.com>
---
Cc: Jonathan Corbet <corbet@lwn.net>
Cc: Liam Girdwood <lgirdwood@gmail.com>
Cc: linux-doc@vger.kernel.org
Cc: linux-kernel@vger.kernel.org
Cc: Mark Brown <broonie@kernel.org>
---
 ...ysfs-platform-regulator-userspace-consumer | 23 +++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer

diff --git a/Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer b/Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer
new file mode 100644
index 000000000000..2d518afb0d32
--- /dev/null
+++ b/Documentation/ABI/testing/sysfs-platform-regulator-userspace-consumer
@@ -0,0 +1,23 @@
+What:		/devices/platform/<device>/uevent EVENT=
+Date:		April 2025
+Contact:	Johann Neuhauser <jneuhauser@dh-electronics.com>
+Description:
+		Reports regulator events via uevents for platform devices
+		controlled by the userspace-consumer regulator driver.
+		
+		Possible EVENT= values:
+		 - ABORT_DISABLE
+		 - ABORT_VOLTAGE_CHANGE
+		 - DISABLE
+		 - ENABLE
+		 - FAIL
+		 - FORCE_DISABLE
+		 - OVER_CURRENT
+		 - OVER_TEMP
+		 - PRE_DISABLE
+		 - PRE_VOLTAGE_CHANGE
+		 - REGULATION_OUT
+		 - UNDER_VOLTAGE
+		 - VOLTAGE_CHANGE
+
+Userspace can monitor these events using udev and respond accordingly.
-- 
2.39.5


  parent reply	other threads:[~2025-04-04 13:42 UTC|newest]

Thread overview: 7+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-04-04 13:40 [PATCH 0/3] regulator: userspace-consumer: Add regulator event uevents Johann Neuhauser
2025-04-04 13:40 ` [PATCH 1/3] regulator: userspace-consumer: Add uevent reporting for regulator events Johann Neuhauser
2025-04-04 13:40 ` Johann Neuhauser [this message]
2025-04-04 13:40 ` [PATCH 3/3] docs: regulator: userspace-consumer: Add uevent-based regulator event reporting Johann Neuhauser
2025-04-04 17:02 ` [PATCH 0/3] regulator: userspace-consumer: Add regulator event uevents Mark Brown
2025-04-07 14:17   ` Johann Neuhauser
2025-04-07 15:57     ` Mark Brown

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=20250404134009.2610460-3-jneuhauser@dh-electronics.com \
    --to=jneuhauser@dh-electronics.com \
    --cc=broonie@kernel.org \
    --cc=corbet@lwn.net \
    --cc=lgirdwood@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-kernel@vger.kernel.org \
    /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

all inboxes | Powered by JetHome®