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